Guidelines for contribution - nornes/tiles-rapIoT GitHub Wiki

Branches

• Name branches as short as possible, but make the name descriptive to make it easy to understand what the branch is for.
• Make a new branch for each new feature to make the differences between the branch and master as small as possible.
• Try to merge with master as soon as the feature is ready.
• Delete a branch after it is merged unless there's a clear reason to keep it open.

Commits

• Make small and frequent commits to make the changes easier to follow.
• Make commits at natural places, for example when one part of the code/feature is done.
• Always have a commit-message describing what was changed and why.

Pull requests

• Make pull requests as soon as the feature of a branch is completed.
• Leave a descriptive message to describe what was changed and why.

Code review

• When a pull request is made everyone is responsible for reviewing the code and commenting. Once the code has been reviewed by one or two persons it can be merged if accepted.
• Keep the comments constructive and suggest changes you feel is needed.