Skip to content

Commit f4c7b3c

Browse files
committed
Add Contributing guide
1 parent 3292a0b commit f4c7b3c

1 file changed

Lines changed: 56 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Contributing to Open Conference URL
2+
3+
## Submitting an issue
4+
5+
### Bug reports
6+
7+
If you are submitting a bug report, please answer the following questions:
8+
9+
- What version of Open Conference URL were you using?
10+
- What were you doing?
11+
- What did you expect to happen?
12+
- What happened instead?
13+
14+
## Contributing code
15+
16+
Pull requests for bug fixes and new features are always welcome. Please be sure
17+
to add or update unit tests as appropriate. Follow the steps below to set up the
18+
repository for contributing.
19+
20+
### Installing project dependencies
21+
22+
You can install all project dependencies via `uv`. This will automatically install a virtualenv for you.
23+
24+
```bash
25+
uv sync
26+
```
27+
28+
### Running unit tests
29+
30+
The project's unit tests are written using and managed under the [nose2][nose2]
31+
Python package. You can run all unit tests via the `nose2` command.
32+
33+
```bash
34+
nose2
35+
```
36+
37+
## Code coverage
38+
39+
The project currently boasts high code coverage across all source files.
40+
Contributions are expected to maintain this high standard. You can view the
41+
current coverage report via the `coverage` command:
42+
43+
```bash
44+
coverage run -m nose2
45+
coverage report
46+
```
47+
48+
If you want to examine which lines are/aren't covered, you can generate and view
49+
a detailed HTML view of the coverage report like so:
50+
51+
```bash
52+
coverage html
53+
open htmlcov/index.html
54+
```
55+
56+
[nose2]: https://docs.nose2.io/en/latest/

0 commit comments

Comments
 (0)