Skip to content

Commit fe4fc33

Browse files
doc: tech stack readability improvement
1 parent cd110ba commit fe4fc33

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

CONTRIBUTING.md

+12-15
Original file line numberDiff line numberDiff line change
@@ -43,21 +43,18 @@ pip install -r requirements-dev.txt
4343

4444
### Our tech stack
4545

46-
All the code of the Library is in [Python](https://www.python.org).
47-
48-
We run our tests using [pytest](https://docs.pytest.org).
49-
50-
We generate our documentation using [Sphinx](https://www.sphinx-doc.org).
51-
52-
We format the code using [black](https://black.readthedocs.io), but this is not
53-
configured yet.
54-
55-
We check our types using [Pyright](https://microsoft.github.io/pyright), but
56-
this is not configured yet.
57-
58-
The documentation is automatically deployed on new versions with
59-
[GitHub Actions](https://docs.github.com/en/actions). (As well as a few other
60-
bits and bobs)
46+
Here are the pieces of software useful to know to work on our library:
47+
48+
- All the code of the Library is in [Python](https://www.python.org).
49+
- We run our tests using [pytest](https://docs.pytest.org).
50+
- We generate our documentation using [Sphinx](https://www.sphinx-doc.org).
51+
- We format the code using [black](https://black.readthedocs.io), but this is not
52+
configured yet.
53+
- We check our types using [Pyright](https://microsoft.github.io/pyright), but
54+
this is not configured yet.
55+
- The documentation is automatically deployed on new versions with
56+
[GitHub Actions](https://docs.github.com/en/actions). (As well as a few other
57+
bits and bobs)
6158

6259
### Implement your changes
6360

0 commit comments

Comments
 (0)