Refer to the following articles on the basics of Git and Github and can also contact the Project Mentors, in case you are stuck:
If you don't have git on your machine, install it.
Thanks for taking the time to contribute! 🐱🏍
When contributing to this repository, please first discuss the change you wish to make via issue or any other method with the owner of this repository (Harsh Mishra) before making a change.
- Take a look at the Existing Issues or create your own Issues!
- Wait for the Issue to be assigned to you after which you can start working on it.
- Fork the Repo and create a Branch for any Issue that you are working upon.
- Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it.
- Add Screenshots to help us know what this Script is all about.
1. Fork this repository. Click on the symbol at the top right corner.
2. Clone the forked repository. Open your git bash on your pc/laptop in relavent folder
git clone https://github.com/<your-github-username>/Discord-Bot.git
3. Navigate to the project directory.
cd Discord-Bot
5. Create a new branch:
git YourBranchName
6. Change to new branch:
git checkout YourBranchName
7. Make changes in source code.
8. Stage your changes and commit
git add "<Your file name along with .(dot)extension>"
git add file.txt
git commit -m "<your_commit_message>"
8. Push your local commits to the remote repo.
git push origin YourBranchName
- Select any issue or created by your own. 💻
- Make sure the problem doesn't already exist in this repository or no one is working on that issue you want to code! 😬
- Create a folder for the topic you wish to add code or if a folder already exists, add your code to it. 📁
- In the respective folder, add your code file with proper format (e.g.
Discord-Bot/API/API.py
)
9. Create a PR !
10. Congratulations! Sit and relax, you've made your contribution to Discord-Bot project.
🏆 After this, project leaders and mentors will review the changes and will merge your PR if they are found good, otherwise we will suggest the required changes.
- Use the present tense (example: "Add feature" and not "Added feature")
- Use the imperative mood (example: "Move item to...", instead of "Moves item to...")
- Limit the first line (also called subject line) to 50 characters or less
- Capitalize the subject line
- Separate subject from body with a blank line
- Do not end the subject line with a period
- Wrap the body at 72 characters
- Use the body to explain what, why, vs, and how
- Reference issues and pull requests liberally after the first line
For major changes, you are welcomed to open an issue about what you would like to contribute. Enhancements will be appreciated.