-
Notifications
You must be signed in to change notification settings - Fork 1
Coding Conventions
Jonas Umland edited this page Nov 12, 2020
·
2 revisions
Here we document a set of conventions that we agreed on. Ideally they would be automatically verified by the CICD system but as this would require some refactorings we first limit ourselves to write them down here. We will do our best to respect these guidelines during our pull request reviews.
- Python Type Hints - use type hints for every method parameter, return value and global variable
- Home
- Setup
- API Documentation
- Data model
- How to...
- ...add a new remote database
- ...create migrations
- ...develop locally
- ...simplified dev setup
- ...deploy on kubernetes (internal)
- ...monitor the cluster
- ...fix expired K8s certificates
- ...add new dependencies
- ...rebuild base image
- ...add a new algorithm in R
- ...add support for new language
- ...add a new node to Kubernetes cluster
- Coding Conventions
- Roadmap
- Ownership