Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (33 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

42 lines (33 loc) · 1.72 KB

IMPORTANT

Please follow the guide here to contribute to the website code. The steps to follow in this tutorial are outlined in section 1 below.

After completing your work, your fork of the repository will be out of date in case your pull request is merged ino the main project. If so, you will need to rebase your repo and clean up history. Skip to section 2 for a tutorial on the same.

Section 1

Steps to follow :

  • Fork the project & clone locally
  • Create an upstream remote and sync your local copy before you branch.
  • Create branch for each separate piece of work
    • If fixing bug, name the branch as bugname_fix
    • If adding feature, name the branch as featurename_feature
    • If working on enhancement, name the branch as enhancementname_enhancement
  • Work!
  • Commit your chages to this branch
    • Write good COMMIT message
    • If fixing an issue, uses closes #issue_number or fixes #issue_number at the end of your commit message to automatically close issue
  • Push your branch to the origin remote
  • Create pull request on GitHub
  • Respond to any code review feedback

Section 2

Follow the guide here from the subhead labelled Cleaning your history (optional) (btw, this isn't optional 😉).

Additionally, always remember:

Always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live.