Internal Docs

Here you can find:

  1. How our development process works
  2. How to contribute to the project
  3. How to write new rules
  4. How our internal API looks like

This information will also be helpful if you would like to create our own flake8 plugin.

How to read this documentation

You will need to start from the glossary where we define the terms for this project.

Then move to the contributing guide where we specify all technical details about our workflow and tools.

And finally you will need to go through the API reference.