Python Quality Assurance

Vision

A Docker image containing tools to ensure the code quality in Python

Ethics

This project operates under the W3C's Code of Ethics and Professional Conduct:

We hope that our community group act according to these guidelines, and that participants hold each other to these high standards. If you have any questions or are worried that the code isn't being followed, please contact the owner of the repository.

Language

The development language is English. All comments and documentation should be written in English, so that we don't end up with “franglais” methods, and so we can share our knowledge with developers around the world.

However, the domain language is French. We consider each tax, collecting organism and French regulation as a domain-specific term. In the same fashion, well-known abbreviations of these domain-specific terms are accepted.

Usage

docker build --rm -t ghcr.io/Connecting-Food/python-quality-assurance:latest .
docker run --rm -it -v $PWD/app:/app ghcr.io/Connecting-Food/python-quality-assurance:latest

Contributing

Development

We're really happy to accept contributions from the community, you will have more information in CONTRIBUTE file! There are many ways to contribute, even if you're not a technical person.

We're using the Git Glow Github flow to accept modifications (even internally), basically you'll have to:

1. Create an issue related to the problem you want to fix (good for traceability and cross-reference).
2. Create a branch (optionally with the reference to the issue in the name).
3. Hack hack hack.
4. Commit incrementally with readable and detailed commit messages.
5. Submit a pull-request against the develop branch of this repository.

Versioning

Version numbering follows the Semantic versioning approach.

License

You will have more information in LICENSE file