Skip to content

Latest commit

 

History

History
20 lines (16 loc) · 1.54 KB

Contribute.md

File metadata and controls

20 lines (16 loc) · 1.54 KB
Raw

Contribute 👩👨🧑👧

Thank you for taking your time to contribute to this project to make it better. Contributing is also a great way to learn more about social coding on Github, new technologies and and their ecosystems and how to make constructive, helpful bug reports, feature requests and the noblest of all contributions: a good, clean pull request. How to make a clean pull request

The project's contribution instructions are as follows.

  • Create a personal fork of this project on Github.
  • Clone the fork on your local machine. Your remote repo on Github is called origin.
  • Add the original repository as a remote called upstream.
  • If you created your fork a while ago be sure to pull upstream changes into your local repository.
  • Create a new branch to work on. Branch from develop if it exists, else from master.
  • Implement/fix your feature, comment your code.
  • Add or change the documentation as needed.
  • Squash your commits into a single commit with git's interactive rebase. Create a new branch if necessary.
  • Push your branch to your fork on Github, the remote origin.
  • From your fork open a pull request in the correct branch. Target the project's develop branch if there is one, else go for master.
  • Once the pull request is approved and merged you can pull the changes from upstream to your local repo and delete your extra branch(es).

And last but not least: Always write your commit messages in the present tense. Your commit message should describe what the commit is.