Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

34 lines (26 loc) · 2.21 KB

Contributing

Issues

Enhancement and bugs are signaled by opening an issue:

  • please use the following labels (if applicable) to help your issue gain visibility:

    • backend
    • frontend
    • documentation
    • ci-cd
    • enhancement
    • bug
  • assign a milestone to your issue if possible.

Contributing to code

  • Branch from master
  • Commit and push -- to your remote branch, not master -- as usual. Try to commit features in an orderly manner so that the following step makes sense.
  • When you are done with your changes, rebase from origin/master and squash commits sensibly. Give a commit description that describes your changes accurately. Use the conventional commits standard. You can find example of scopes in your git history (git log).
  • Make a Pull Request (PR) on GitHub.
  • You have to pass the automated tests before asking for a review. If you fail them, commit and push a fix on the same branch, the tests will be rerun.
  • Ask for 1 reviews on Discord, the reviewer should assign himself to the PR
  • Wait for the review
  • The reviewer discusses your code. Discuss and/or make the suggested changes. All conversations must be resolved before merging.
  • Each PR should be open for at least 24 hours to give additional collaborators a chance to review your work if they choose to do so. They should assign themselves to the PR and send a message on Discord.
  • Once all reviews are complete, all the conversations are resolved, all the tests pass, and at least one reviewer has approved your PR, you can merge your work with master.

Rules of thumb:

  • Use conventional commits everywhere, even before squashing. It will force you to adopt an organised mindset.
  • Each issue/feature should have its own branch and PR. This will keep PRs short, which speeds up the review process and prevents reviewers from getting overwhelmed. Short, isolated PRs mean that independent parts can be reviewed and merged quickly without waiting for comment resolution on unrelated features.
  • Everything on the repository is public. Hence keep your interactions calm, respectful and polite. Also, please refrain from naming commits with descriptions like pushing my branch, whatever, hello, etc.