CONTRIBUTING.md

⚙ Setup Git If You've Never Used Git Before

• git config --global user.name "YourUsername"
• git config --global user.email "[email protected]"

👨‍💻 Contributing

• Take a look at the existing Issues or create a new issue!
• Fork the Repo, create a branch for any issue that you are working on and commit your work.
• Create a Pull Request (PR), which will be promptly reviewed and given suggestions for improvements by the community.
• Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes that are included in your commits.

⭐ HOW TO MAKE A PULL REQUEST:

1. Start by making a fork the TakeABreak repository. Click on the symbol at the top right corner.

2. Clone your new fork of the repository:

git clone https://github.com/<your-github-username>/TakeABreak

3. Set upstream command:

git remote add upstream https://github.com/Daksh777/TakeABreak.git

4. Navigate to the new project directory:

cd TakeABreak

5. Create a new branch:

git checkout -b YourBranchName

6. Sync your fork or local repository with the origin repository:

• In your forked repository click on "Fetch upstream"
• Click "Fetch and merge".

Alternatively, Git CLI way to Sync forked repository with origin repository:

git fetch upstream

git merge upstream/main

Github Docs for Syncing

7. Make your changes to the source code.

8. Stage your changes and commit:

git add .

git commit -m "<your_commit_message>"

9. Push your local commits to the remote repository:

git push origin YourBranchName

10. Create a Pull Request! After some time, your changes will be merged into the main branch of this project (after being reviewed, of course). You'll receive a notification email once it's done.

11. Congratulations! You've made your first contribution! 🙌🏼

All the best! 🥇

🛡️ License

TakeABreak is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE - see the LICENSE file for details.

Any questions, feel free to let us know!

You can contact me here

🙏 Support

This project needs a ⭐️ from you. Don't forget to leave a star ⭐️

Thanks to all the contributors ❤️

---