Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

81 lines (55 loc) · 2.93 KB
Raw

Contributing

Contributions are welcome! Please open issues on the repository, or submit a PR.

Issue Reporting

Please report any bugs and suggest features by creating an issue.

Please note that as of right now, I (Sumner) am basically the only contributor to this project, so my response time to your issue may be anywhere from instant to infinite.

When reporting a bug, please be as specific as possible, and include steps to reproduce.

Code

If you want to propose a code change, please submit a PR. If it is good, I will merge it in.

Installing Development Dependencies

This project uses Poetry for dependency management. Make sure that you have poetry (and pyenv if necessary) set up properly, then run:

$ poetry install

to install the development dependencies as well as install tracktime into the virtual environment.

Note: a .envrc is provided for use with direnv to automatically run the poetry install and activate the virtual environment when in the project directory.

Running

It is recommended to activate the virtual environment using either poetry shell or by activating it manually using:

source $(poetry env info -p)/bin/activate

Once the virtual environment is activated, you can run tt as normal.

Code Style

This project follows PEP-8 strictly. The only exception is maximum line length, which is 88 for this project (in accordance with black's defaults). Lines that contain a single string literal are allowed to extend past the maximum line length limit.

This project uses flake8, mypy, and black to do static analysis of the code and to enforce a consistent (and as deterministic as possible) code style.

Although you can technically do all of the formatting yourself, it is recommended that you use the following tools (they are automatically installed if you are using poetry). The CI process uses these to check all commits, so you will probably want to run them locally so you don't have to wait for results of the build before knowing if your code is the correct style.

  • flake8 is used for linting. The following additional plugin is also used:

  • mypy is used for type checking. All type errors must be resolved.

  • black is used for auto-formatting. The CI process runs black --check to make sure that you've run black on all files (or are just good at manually formatting).

The CI process uses all three tools to analyse the Python code. You can run the same checks that the lint job runs yourself with the following commands:

$ poetry check
$ flake8
$ mypy tracktime
$ black --check .
$ .builds/bin/custom_style_check.py