Skip to content

Commit b1772df

Browse files
committed
Add contributing guide [skip ci]
1 parent 7f0e7ac commit b1772df

File tree

2 files changed

+63
-2
lines changed

2 files changed

+63
-2
lines changed

CONTRIBUTING.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Contributing to Python JSONPath RFC 9535
2+
3+
Hi. Your contributions and questions are always welcome. Feel free to ask questions, report bugs or request features on the [issue tracker](https://github.com/jg-rp/python-jsonpath-rfc9535/issues) or on [Github Discussions](https://github.com/jg-rp/python-jsonpath-rfc9535/discussions). Pull requests are welcome too.
4+
5+
**Table of contents**
6+
7+
- [Development](#development)
8+
- [Documentation](#documentation)
9+
- [Style Guides](#style-guides)
10+
11+
## Development
12+
13+
We use [hatch](https://hatch.pypa.io/latest/) to manage project dependencies and development environments.
14+
15+
Run tests with the _test_ script.
16+
17+
```shell
18+
$ hatch run test
19+
```
20+
21+
Lint with [ruff](https://beta.ruff.rs/docs/).
22+
23+
```shell
24+
$ hatch run lint
25+
```
26+
27+
Typecheck with [Mypy](https://mypy.readthedocs.io/en/stable/).
28+
29+
```shell
30+
$ hatch run typing
31+
```
32+
33+
Check coverage with pytest-cov.
34+
35+
```shell
36+
$ hatch run cov
37+
```
38+
39+
Or generate an HTML coverage report.
40+
41+
```shell
42+
$ hatch run cov-html
43+
```
44+
45+
Then open `htmlcov/index.html` in your browser.
46+
47+
## Documentation
48+
49+
Documentation is currently in the [README](https://github.com/jg-rp/python-jsonpath-rfc9535/blob/main/README.md) and project source code only.
50+
51+
## Style Guides
52+
53+
### Git Commit Messages
54+
55+
There are no hard rules for git commit messages, although you might like to indicate the type of commit by starting the message with `docs:`, `chore:`, `feat:`, `fix:` or `refactor:`, for example.
56+
57+
### Python Style
58+
59+
All Python files are formatted using [Black](https://github.com/psf/black), with its default configuration.
60+
61+
Docstrings must use [Google style docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html).

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ We follow <a href="https://datatracker.ietf.org/doc/html/rfc9535">RFC 9535</a> s
66

77
<p align="center">
88
<a href="https://github.com/jg-rp/python-jsonpath-rfc9535/blob/main/LICENSE.txt">
9-
<img src="https://img.shields.io/pypi/l/jsonpath-rfc9535?style=flat-square" alt="License">
9+
<img src="https://img.shields.io/pypi/l/jsonpath-rfc9535.svg?style=flat-square" alt="License">
1010
</a>
1111
<a href="https://github.com/jg-rp/python-jsonpath-rfc9535/actions">
1212
<img src="https://img.shields.io/github/actions/workflow/status/jg-rp/python-jsonpath-rfc9535/tests.yaml?branch=main&label=tests&style=flat-square" alt="Tests">
@@ -97,7 +97,7 @@ products = jsonpath.find("$..products.*", data).values()
9797
## Links
9898

9999
- Change log: https://github.com/jg-rp/python-jsonpath-rfc9535/blob/main/CHANGELOG.md
100-
- PyPi: [TODO](https://pypi.org/project/jsonpath-rfc9535)
100+
- PyPi: https://pypi.org/project/jsonpath-rfc9535
101101
- Source code: https://github.com/jg-rp/python-jsonpath-rfc9535
102102
- Issue tracker: https://github.com/jg-rp/python-jsonpath-rfc9535/issues
103103

0 commit comments

Comments
 (0)