Welcome to WindPioneers! This repository defines settings and workflows that are applied universally across all WindPioneers repositories.
Some general rules that we stick to when using GitHub
- Repositories are named using
kebab-caseconventions to reduce friction when collaborating with others or setting up build scripts - Repositories should have meaningful names with a subject/area, as well as an indicator of function/purpose, eg
wake-serviceis a webservice (function/purpose) to calculate wake interactions (the subject/area),windquest-frontendis part of the windquest group of apps.
- It's your responsibility to keep devcontainers, dev tooling and CI/CD workflows up to date for your repositories. You can see (and add to yourself) some best practices on python libraries and applications, semantic versioning and Terraform / IAC.
- All repos should use
pre-committo enforce styling consistency and QC. See established repos for pre-comit configuration examples specific to your language. - Frontend / Javascript repositories should use
biomeas a comprehensive code formatter - Python repositories should conform to the
ruffstyle guide - R repositories should conform to the
google Rstyle guide - C++ repositories should conform to the
google C++style guide