DevelopmentRules

List of development rules and guidelines

• Branch main is owned by release managers
  • i. e. pull requests on main will be declined
• development is accumulated on branch develop
  • git-flow-alike we'll keep a running and working code-base on main
  • exchanging not-yet-finished features shall be done on feature branches, if we haven't created one that's needed, please file an issue / send a message / use smoke signal or bush telegraphy before applying a pull request ;)
  • if you finished a feature, feel free to create PR from your fork's feature branch towards our develop
    • PRs from your develop towards our develop will, in general, be declined
  • Send hotfix pull request for production/critical bugs to master and develop branches
    • this complies with git-flow rules too, so to keep things in sync: we'll not merge something different into develop, than we merged into main. So please don't close your hotfix branch, until both PRs are successfully merged.
• release managers decide, when (our) develop is ready to define a new release/... branch
• keep volatile or environment specific data or values out of repository
• don't commit generated, cache or runtime created files
• use .gitignore to prevent yourself and others from accidentally committing runtime files
• black and flake8 are mandatory