Merge pull request #43 from nerdy-nakul/nerdy-nakul-patch-1

Created contributing_guide.md

contributing_guide.md

@@ -0,0 +1,110 @@
+# Contributing to Bot-Collection
+
+## Thank you for considering contributing to Bot-Collection! 
+
+Whether it's fixing a `bug` , `proposing a new feature` , or `improving documentation`, your contributions are greatly appreciated.
+
+## Code of Conduct
+
+Please make sure to read and follow our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing to the project.
+
+## Getting Started
+
+**1.** Fork [this](https://github.com/neelshah2409/Bot-Collection) repository.
+
+**2.** Clone your forked copy of the project.
+
+```
+git clone https://github.com/<your_user_name>/Bot-Collection.git
+```
+
+where `your_user_name` is your GitHub username.
+
+**3.** Navigate to the project directory.
+
+```
+cd Bot-Collection
+```
+
+**4.** Add a reference(remote) to the original repository.
+
+```
+git remote add upstream https://github.com/neelshah2409/Bot-Collection.git
+```
+
+**5.** Check the remotes for this repository.
+
+```
+git remote -v
+```
+
+**6.** Always take a pull from the upstream repository to your main branch to keep it at par with the main project (updated repository).
+
+```
+git pull upstream main
+```
+
+**7.** Create a new branch.
+
+```
+git checkout -b <your_branch_name>
+```
+
+**8.** Make necessary changes and commit those changes
+
+**9.** Track your changes.
+
+```
+git add .
+```
+
+**10.** Commit your changes .
+
+```
+git commit -m "Commit message"
+```
+
+**11.** Push the committed changes in your feature branch to your remote repo.
+
+```
+git push -u origin <your_branch_name>
+```
+
+**12.** To create a pull request, click on `compare and pull requests`. Please ensure you compare your feature branch to the desired branch of the repo you are suppose to make a PR to.
+
+**13.** Add appropriate title and description to your pull request explaining your changes and efforts done.
+
+**14.** Click on `Create Pull Request`.
+
+**15.** And you are done creating a pull request to this project. Be patient while we review your code and merge the changes.
+
+
+## Submitting a Pull Request
+
+1. Make sure your changes are well-documented and include relevant tests.
+
+2. If you've added new functionality, include appropriate documentation.
+
+3. Follow the coding conventions used in the project.
+
+4. Before submitting your pull request, make sure the following items have been checked:
+
+   - All tests pass and the build is successful.
+   - Your changes do not produce any new warnings or errors.
+   - Your changes have been thoroughly tested on different platforms and browsers.
+   - Your changes do not break backward compatibility.
+
+5. When you're ready, submit a pull request and include a descriptive title and a detailed description of your changes.
+
+## Additional Resources
+
+- [Project documentation]()
+- [Issue tracker]()
+
+## Questions and Support
+
+If you have any questions or need any help, please feel free to open an issue in the repository.
+
+Thank you again for your interest in contributing to Bot-Collection. 
+
+We look forward to working with you!