Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

38 lines (27 loc) · 1.57 KB
Raw

Contributing

Thanks for your interest in unkey.py! Here are some tips for contributing.

Guidelines

  • If you have an idea, but are unsure on the proper implementation - open an issue.
  • Implementations should be well tested before opening a pull request.
  • Max code line length of 99, max docs line length of 80.
  • Code should be written in black's code style.
  • Code should be PEP 8 compliant.
  • Use informative commit messages.

Installing poetry

unkey.py uses Poetry for dependency management.

Check out poetry's full installation guide for detailed instructions if you aren't familiar with it.

Installing dependencies

  1. Create a fork of unkey.py, and clone the fork to your local machine.
  2. Change directory into the project dir.
  3. Run poetry shell to create a new virtual environment, and activate it.
  4. Run poetry install to install dependencies (this includes dev deps).

Writing code

  1. Check out a new branch to commit your work to, e.g. git checkout -b bugfix/typing-errors.
  2. Make your changes, then run nox and address any issues that arise.
  3. Commit your work, using an informative commit message.
  4. Open a pull request into the master branch of this repository.

After submitting your PR, it will be reviewed (and hopefully merged!). Thanks again for taking the time to read this contributing guide, and for your interest in unkey.py. I look forward to working with you.