Contributing Guidelines

Creating an issue

Please use one of the issue templates in the issues section!

Branch naming

Create a branch with the following format: <issue number>-<name>

Here's the cli for creating a new branch:

git checkout master
git pull
git checkout -b <branch name>

Alternatively, you can create a branch by clicking Create a branch, under the Development tab of an Issue.

Commits

Please take a look at Semantic Commit Messages, we have commit lints that enforce this rule.

Commit types must be one of:

[build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test]

E.g.

chore: add Oyster build script
docs: explain hat wobble
feat: add beta sequence
fix: remove broken confirmation message
refactor: share logic between 4d3d3d3 and flarhgunnstow
style: convert tabs to spaces
test: ensure Tayne retains clothing

Pull requests

You must create a pull request when changing the master branch. Please request a review from another developer that has best knowledge towards the changes made.

Note to reviewers: Please keep the language professional and friendly!

Merging

Please only merge if you have the most contributions in the pull request, the merge credit goes towards you!