File: CONTRIBUTING.md

package info (click to toggle)
python-ical 12.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,776 kB
  • sloc: python: 15,157; sh: 9; makefile: 5
file content (33 lines) | stat: -rw-r--r-- 591 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
# Contributing

Thank you for contributing! This section describes the typical steps in
setting up a development environment.

## Setup a virtual environment

```
$ uv venv --python=3.13
$ source .venv/bin/activate
$ uv pip install -r requirements_dev.txt
```

## Running the tests

From within your virtual environment:

```
$ pytest
```

## Running pre-commit

Before sending a PR ensure the formatting is correct:

```
$ pre-commit
```

## Contributing

Committing the change will run all necessary formatting, type checking, and
linting. Prefer small PRs to make reviews easy to manage.