This documentation contains a set of guidelines to help you during the contribution process.
We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project.
Thank you for helping out and remember, no contribution is too small.
Please note we have a code of conduct please follow it in all your interactions with the project.
You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:
- Forking a Repo
- Cloning a Repo
- How to create a Pull Request
- Getting started with Git and GitHub
- Learn GitHub from Scratch
-
Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.
-
Clone the Repository:
- If you haven't cloned the repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
- Choose the repository from the list of repositories on GitHub and clone it to your local machine.
-
Switch to the Correct Branch:
- Ensure you are on the branch that you want to submit a pull request for.
- If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.
-
Make Changes: Make your changes to the code or files in the repository using your preferred code editor.
-
Commit Changes:
- In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
- Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.
-
Push Changes to GitHub: After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.
-
Create a Pull Request:
- Go to the GitHub website and navigate to your fork of the repository.
- You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.
-
Review and Submit:
- On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
- Once you're satisfied, click the "Create pull request" button to submit your pull request.
-
Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the repository.
- Go to the project's issues.
- Give proper description for the issues.
- Don't spam to get the assignment of the issue 😀.
- Wait for till someone is looking into it !.
- Start working on issue only after you got assigned that issue 🚀.
Fork the repository.
Clone the forked repository on your local machine.
git clone https://github.com/<your_github_username>/EmoWell.git
Open command prompt/Terminal.
Shoot up a terminal and run:
cd EmoWell
For installing all the required dependencies and packages
npm install
This will open up the website on localhost. You can begin working. The changes will be reflected here. To access it navigate to http://localhost:5173/ in your browser
npm run dev
- Do not edit/delete someone else's script in this repository. You can only insert new files/folders into this repository.
- Give a meaningful name to whatever file or folder you are adding, changing, etc.
- Welcome to this repository, if you are here as an open-source program participant/contributor.
- Participants/contributors have to comment on issues they would like to work on, and mentors or the PA will assign you.
- Issues will be assigned on a first-come, first-serve basis.
- Participants/contributors can also open their issues using issue_template, but it needs to be verified and labeled by a mentor or PA. Please discuss this with the team once before opening your issues. We respect all your contributions, whether it is an Issue or a Pull Request.
- When you raise an issue, make sure you get it assigned to you before you start working on that project.
- Each participant/contributor will be assigned 1 issue (max) at a time to work.
- Participants are expected to follow project guidelines and coding style . Structured code is one of our top priorities.
- Try to explain your approach to solving any issue in the comments. This will increase the chances of you being assigned.
- Don't create issues that are already listed.
- Please don't pick up an issue already assigned to someone else. Work on the issues after it gets assigned to you.
- Make sure you discuss issues before working on the issue.
- Pull requests will be merged after being reviewed by a mentor or PA.
- It might take a day or two to review your pull request. Please have patience and be nice.
- Always create a pull request from a branch other than
main. - Participants/contributors have to complete issues before they decided Deadline. If you fail to make a PR within the deadline, then the issue will be assigned to another person in the queue.
- While making PRs, don't forget to add a description of your work.
- Include the issue number (Fixes: issue number) in your commit message while creating a pull request.
- Make sure your solution to any issue is better in terms of performance and other parameters in comparison to the previous work.
- We all are here to learn. You are allowed to make mistakes. That's how you learn, right?
- Ensure that you have self reviewed your code 😀
- Make sure you have added the proper description for the functionality of the code
- I have commented my code, particularly in hard-to-understand areas.
- Add screenshot it help in review.
- Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon 🚀