Skip to main content

Rules

Git​

  1. Make sure GPG key is setup to sign all commits
  2. Try to keep a linear git history (search for it if you don't know)

GitHub​

  1. Do not push to main or develop, use PR
  2. Sign all commits with GPG key, make sure commits have Verified on GitHub
  3. Follow the workflow to create a branch
  4. When merging a PR, use Squash and Merge

Starting a Feature/Fix​

  1. Create an item on project board
  2. Convert to issue to link to a repo
  3. Go to the issue, click create a branch to link the branch to issue
    1. 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.

  1. Click on the Gear Icon of an issue to select a branch
    1. 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​

  1. Always reformat the code
    1. Prettier, or other language-specific extensions
  2. Document complex functions
  3. Think before coding, follow good design pattern, code muxt be modular