Skip to content

Commit 3131183

Browse files
committed
Docs on coding style/contributions
1 parent 0514d95 commit 3131183

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

docs/contributing.rst

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,19 @@ Contributions to parsy, whether code or docs, are very welcome. Please
55
contribute by making a fork, and submitting a PR on `GitHub
66
<https://github.com/python-parsy/parsy>`_.
77

8-
We have a high standard in terms of quality. All contributions will need to be
9-
fully covered by unit tests and documentation.
8+
Some notes on the culture/philosophy and coding style:
9+
10+
- We have a high standard in terms of quality. All contributions will need to be
11+
fully covered by unit tests and documentation.
12+
13+
- We have extremely high standards in terms of backwards compatibility – close
14+
to zero-tolerance for any breaking changes.
15+
16+
- This project predates extensive type hints, and there are serious difficulties
17+
in making them useful. We take a pragmatic approach, using them essentially
18+
for documentation and to help with auto-complete for the user, but not strict
19+
type-checking. See `issue #64
20+
<https://github.com/python-parsy/parsy/issues/64>`__ for more info.
1021

1122
To get started you’ll need to:
1223

0 commit comments

Comments
 (0)