Skip to content

Commit 2ef87c7

Browse files
committed
add CONTRIBUTING.md
1 parent c437ea7 commit 2ef87c7

File tree

2 files changed

+36
-29
lines changed

2 files changed

+36
-29
lines changed

CONTRIBUTING.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing
2+
3+
So excited to have you here! If you want any guidance whatsoever, don't hesitate to reach out on [Discord](https://discopy.org/discord)!
4+
5+
## Run the tests
6+
7+
The first step is clone DisCoPy and install it locally.
8+
9+
```shell
10+
git clone https://github.com/discopy/discopy.git
11+
cd discopy
12+
pip install .
13+
```
14+
15+
Then you should check you haven't broken anything by running the test suite:
16+
17+
```shell
18+
pip install ".[test]" .
19+
coverage run -m pytest --doctest-modules --pycodestyle
20+
coverage report -m discopy/*.py discopy/*/*.py
21+
```
22+
23+
## Build the docs
24+
25+
You can build the documentation locally with [sphinx](https://www.sphinx-doc.org/en/master/):
26+
27+
```shell
28+
pip install ".[docs]" .
29+
sphinx-build docs docs/_build/html
30+
```

README.md

+6-29
Original file line numberDiff line numberDiff line change
@@ -37,43 +37,20 @@ Software dependencies between modules go top-to-bottom, left-to-right and [forge
3737

3838
[![architecture](https://github.com/discopy/discopy/blob/main/docs/api/architecture.png)](https://docs.discopy.org#architecture)
3939

40-
## Install
40+
## Quickstart
4141

4242
```shell
4343
pip install discopy
4444
```
4545

46-
## Test
47-
48-
If you want the bleeding edge, you can install DisCoPy locally:
49-
50-
```shell
51-
git clone https://github.com/discopy/discopy.git
52-
cd discopy
53-
pip install .
54-
```
55-
56-
You should check you haven't broken anything by running the test suite:
57-
58-
```shell
59-
pip install ".[test]" .
60-
coverage run -m pytest --doctest-modules --pycodestyle
61-
coverage report -m discopy/*.py discopy/*/*.py
62-
```
63-
64-
The documentation is built using
65-
[sphinx](https://www.sphinx-doc.org/en/master/).
66-
You can build it locally with:
67-
68-
```shell
69-
pip install ".[docs]" .
70-
sphinx-build docs docs/_build/html
71-
```
46+
If you want to see DisCoPy in action, check out the [QNLP tutorial](https://docs.discopy.org/en/main/notebooks/qnlp.html)!
7247

7348
## Contribute
7449

75-
Contributions are welcome, please get in touch or
76-
[open an issue](https://github.com/discopy/discopy/issues/new).
50+
We're keen to welcome new contributors!
51+
First, read the [Contributing Guidelines](https://github.com/discopy/discopy/CONTRIBUTING.md).
52+
Then get in touch on [Discord](https://discopy.org/discord)
53+
or [open an issue](https://github.com/discopy/discopy/issues/new).
7754

7855
## How to cite
7956

0 commit comments

Comments
 (0)