Skip to content

Latest commit

 

History

History
80 lines (63 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

80 lines (63 loc) · 2.48 KB
Raw

Certbot Contributing Guide

Hi! Welcome to the Certbot project. We look forward to collaborating with you.

If you're reporting a bug in Certbot, please make sure to include:

  • The version of Certbot you're running.
  • The operating system you're running it on.
  • The commands you ran.
  • What you expected to happen, and
  • What actually happened.

If you're a developer, we have some helpful information in our Developer's Guide to get you started. In particular, we recommend you read these sections

Specific instructions for Josepy

Configure a development environment

  1. Install Poetry: https://python-poetry.org/docs/#installation
  2. Setup a Python virtual environment
$ poetry install -E docs
  1. Activate the Python virtual environment
# (On Linux)
$ source .venv/bin/activate
# (On Windows Powershell)
$ .\.venv\Script\activate
  1. Optionally set up pre-commit which will cause simple tests to be automatically run on your changes when you commit them
$ pre-commit install

Run the tests and quality checks

  1. Configure a development environment (see above)
  2. Run the tests
$ tox
  1. You can also run specific tests
$ tox -e py

You can get a listing of the available tests by running

$ tox -l

Updating dependencies

Our poetry.lock file is only used during development so security vulnerabilities in the pinned packages are rarely relevant. With that said, if you want to update package versions, you can use the poetry update command.