File: CONTRIBUTING.md

package info (click to toggle)
python-dotenv 1.2.1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 316 kB
  • sloc: python: 2,118; makefile: 52
file content (35 lines) | stat: -rw-r--r-- 677 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Contributing
============

All the contributions are welcome! Please open [an
issue](https://github.com/theskumar/python-dotenv/issues/new) or send us
a pull request.

Executing the tests:

    $ uv venv
    $ uv pip install -r requirements.txt
    $ uv pip install -e .
    $ uv ruff check .
    $ uv format .
    $ uv run pytest

or with [tox](https://pypi.org/project/tox/) installed:

    $ tox


Use of pre-commit is recommended:

    $ uv run precommit install


Documentation is published with [mkdocs]():

```shell
$ uv pip install -r requirements-docs.txt
$ uv pip install -e .
$ uv run mkdocs serve
```

Open http://127.0.0.1:8000/ to view the documentation locally.