Rules
Git
- Make sure GPG key is setup to sign all commits
- Try to keep a linear git history (search for it if you don't know)
GitHub
- Do not push to
mainordevelop, use PR - Sign all commits with GPG key, make sure commits have
Verifiedon GitHub - Follow the workflow to create a branch
- When merging a PR, use Squash and Merge
Starting a Feature/Fix
- Create an item on project board
- Convert to issue to link to a repo
- Go to the issue, click create a branch to link the branch to issue
- PR will also be linked to the Issue
If you didn't start a branch like this, please also link your branch to an issue manually.
- Click on the Gear Icon of an issue to select a branch
- PR will be linked
For a PR that affect multiple issues, go to each issue and link the branch.
In other special cases, make sure a PR is at least mentioned in some issue.
Code
- Always reformat the code
- Prettier, or other language-specific extensions
- Document complex functions
- Think before coding, follow good design pattern, code muxt be modular