-
Notifications
You must be signed in to change notification settings - Fork 5
Contribution workflow
- Head to https://waffle.io/shri-2015-org/shrimp and pick existing issue or create a new one.
- When actively working on an issue, move the ticket to "In Progress", so other team members would see where you at.
- Follow Github flow: https://guides.github.com/introduction/flow/.
- Follow this convention for branch naming:
<type>/<short_name>#<issue_number>.
Where <type> may be among: feat, fix, docs, refactor, test, chore (build changes).
- PR message should be formatted in this way:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
Closes: #123
-
Commit messages may follow free format, but if the branch has only one commit, it's advised to format it in the same way as PR, and it would automatically be inserted as PR message.
-
When pulling latest changes from master, prefer rebase to merge where possible, to keep history clean:
git pull --rebase origin master -
For hotfixes or little things this workflow may be simplified: e.g. you may not want to create a ticket for something you have already done (in that case the branch name may just be
<type>/<short_name>). -
All changes must pass code review. After PR is created, at least two positive comments must be recorded in PR discussion, before the PR may be merged. Don't be discouraged by downvotes: it's much better to fix issues before merging, than applying hotfixes all over the place!
-
Always delete branches after merge with master. For follow-up changes a new branch and a new ticket should be created.
We adhere to AirBnb JavaScript styleguide. Watch for linter error on pre-commit hook. For other stuff use common sense and code reviews by other team members.