Skip to content

Latest commit

 

History

History
21 lines (18 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

21 lines (18 loc) · 1.35 KB

Contributing

Please follow a few guidelines in order to contribute to the project:

  1. Pick an issue in the backlog and assign it to yourself.
  2. Always create a new branch git branch branch_name and all changes you make should be in that branch.
  3. Make the changes needed then save and commit them:
    • Use git status to see what changes there are that can be committed.
    • To add a file to be commited: git add filename (this will stage the file for a commit)
    • Once all files you want to commit are added you can commit the changes git commit and make sure to add a meaningful message to describe what changes you have made.
  4. [Raise a Pull Request](## How to raise a Pull Request ) so other teammembers can review the changes before they are merged5.
  5. Have at least 1 team member review your code (ideally 2) and once you receive a 👍 you can merge the code.

How to raise a Pull Request

In order to raise a Pull Request with your changes:

  • Save and commit your changes
  • Push your changes and create a pull request: git push origin your_branch_name
  • Go to the repo and you should see a green button "Raise a Pull Request"
  • Describe all the changes you have made in details and save.