Skip to content
This repository has been archived by the owner on Jan 15, 2024. It is now read-only.

Latest commit

 

History

History
13 lines (8 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

13 lines (8 loc) · 1.08 KB

Versioning

We're using CalVer for versioning with the YYYY.0W format!

Style

This is largely copied from Cog-Creators/Red-DiscordBot. I might change things eventually but this 'just works' for now.

Our style checker of choice, black, actually happens to be an auto-formatter. The checking functionality simply detects whether or not it would try to reformat something in your code, should you run the formatter on it. For this reason, we recommend using this tool as a formatter, regardless of any disagreements you might have with the style it enforces.

Use the command black --help to see how to use this tool. The full style guide is explained in detail on black's GitHub repository. There is one exception to this, however, which is that we set the line length to 99, instead of black's default 88. This is already set in pyproject.toml configuration file in the repo so you can simply format code with Black like so: black <src>.

Environments

We use pipenv to manage dependencies.