Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

58 lines (42 loc) · 2.88 KB
Raw

Contributing to Hacktoberfest2020

Thanks for taking the time to contribute

The following is a set of guidelines for contributing to "Hacktoberfest2020". These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How can I contribute?

  1. You can report bugs/glitches/faults that you are likely to come across when using the project.
  2. You can suggest enhancements that you would want to see implemented on the project by creating an issue.
  3. You can address a wide variety of open issues by claiming them if you wish to contribute and make a pull request.

Steps to contribute for new comers (For First Timers)

  • Fork this repo and give it a star.

  • Add your name in the list of people who contributed in this repo in README.md file.

  • Generate and get idea by making pull requests to this repo and complete 1 PR in Hacktoberfest 2020.

Steps to contribute and resolve/raise an issue

  • Comment on the issue you want to work on. Make sure it's not assigned to someone else. For new comers to open-source, you can pick the issue having 'good first issue' tag.

  • If you think you encounter a bug or have a suggestion for improvement of code or to add a feature, then create a issue with proper title and tags but first make sure it's not already present.

Making a PR

  • Fork the repo. This will create a copy of the current repository that you can edit and make changes to.

  • Clone it on your machine. But first navigate to your forked repo and then, there you will find link provided by GitHub to clone.

  • Add a upstream link to main branch in your cloned repo

    git remote add upstream https://github.com/atyant-yadav/Hacktoberfest2020.git

  • Keep your cloned repo upto date by pulling from upstream (this will also avoid any merge conflicts while committing new changes)

    git pull upstream main https://github.com/atyant-yadav/Hacktoberfest2020.git

  • Create your feature branch

    git checkout -b <feature-name>

  • Commit all the changes

    git commit -m "Meaningful Commit Message"

  • Push the changes for review

    git push origin <branch-name>

  • Create a PR from your repo on GitHub. Give a proper title and description for the changes you made.

  • The maintainer of this repo will review the changes you have made. If they find any errors/mistakes, they may request some changes; in which case, you should make the appropriate changes in your forked repository and then commit them again. Note: Make sure you make changes in the same branch you previously requested PR from.

  • At last, if maintainers review and come to a conclusion that your PR is good to go, then your request will be approved and will be merged.

Happy Hacktoberfest! Happy Coding! Keep Contributing! If you liked this repo or learned something from it, do not forget to give it a star :)