nqrduck/NQRduckumentation
1
0
Fork 1
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

Improved style section.

Browse source
This commit is contained in:
jupfi 2024-05-21 14:57:48 +02:00
parent 33cb5d467e
commit 30fe0b575b
1 changed files with 17 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

17
source/software_structure/development.md
View file

@ -4,6 +4,8 @@ This section describes the process of developing the NQRduck software.
## Style
### Linting
Linting is done using [ruff](https://astral.sh/ruff) with the following configuration specified in the `pyproject.toml` file:
```toml
@ -28,6 +30,21 @@ convention = "google"
Run `ruff check` to lint the code, ideally in a pre-commit hook.
### Formatting
Formatting is done using [black](https://black.readthedocs.io/en/stable/).
### Typing
Use type hints for all functions and classes. The type hints should be as specific as possible.
## Documentation
Documentation is implemented with [Sphinx](https://www.sphinx-doc.org/en/master/) project. The documentation is located in `NQRduckumentation` repository.
For docstrings in the code, the [Google style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) is used.
## Branching
The main branch is used for releases. Development is done on a development branch. Feature branches are created from the development branch and merged back into it. The development branch is merged into the main branch for releases. Releases are tagged with a version number starting with `v` (e.g. `v0.1.0`) and should follow [semantic versioning](https://semver.org/) (right now they don't).