Based on our discussion during the meeting, I am proposing development guidelines. Feel free to add your ideas and feedback.
Contributing
Code is structured as a core package with public API and CLI tool.
All Python dependencies, installation, and tests are managed by setup.py.
CLI tool uses standard exit codes and additional defined as the same Enum.
Warnings are enabled and forwarded to logs.
Git workflow is simplified GitFlow without release branches. When a feature is finished in its feature branch, its author creates pull request to the dev branch. Branches dev and master are protected and require pull request review. The author should request 2 other team members for a code review. Branch master contains only production-ready state.
Development Guidelines
All code merged to dev has unit tests and documentation.
Based on our discussion during the meeting, I am proposing development guidelines. Feel free to add your ideas and feedback.
Contributing
setup.py
.dev
branch. Branchesdev
andmaster
are protected and require pull request review. The author should request 2 other team members for a code review. Branchmaster
contains only production-ready state.Development Guidelines
dev
has unit tests and documentation.doctest
. Documentation can be parsed from docstrings.typing
where specific type is expected.logging
, but don't log any sensitive information. Every module has its logger.