Skip to main content

03-Best practices

  1. See the Best Practices repo

  • We value high quality and craft.
  • Please adhere to coding best practices, as written there and to the idioms of the frameworks you are using.

  1. General Contributing Guidelines

  • Check out git.md from best standards and the general guidelines, here for the most essential ones.

  1. Make Sure You Know Why

  • It all starts with why. Make sure you know why. Question it as well.
  • Pivot! Pivot in your implementation and effort. Don't waste hours in a nuance compared to what's real value.
  • Good quality is a why in itself. Look good, do good.

  1. Write Issues & Use Templates

  • Writing issues is appreciated! Use our Templates to help you out.
  • If you don't know which issue tracker to use at all, you can also use our Idea/Feedback Form!

  1. Work in Branches & Commit Often

  • When you code, clone the repo and create your own branch.
  • Commit often. No 3000 edits in one commit. Meaningful units of work, so that you could explain every edit to somebody else easily.
  • Use conventional-commits in commit messages. Eg. "fix: fixed language bug at LoginView"

  1. Use Pre-Commit and make sure it & tests pass

  • Use pre-commit for clean code and to avoid gross mistakes.
  • Tests are friends, write unit tests and make sure they pass.

  1. Security Implied

  • Recognize what might imply security issues, ticket that and label it 'security-implied.'
  • Discuss problems you might see, whether on your own code, others' code or the present code at repositories or the usage of them

\