Skip to content

Commit 07cf2be

Browse files
committed
Updated instructions
1 parent cc2b6cb commit 07cf2be

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ structures are welcome but must first be discussed in an issue, especially when
3030
it comes to performance critical parts. Please include supporting theoretical
3131
or experimental evidence for such contributions.
3232

33+
NB: Contributions from bots or fully automated AI agents are discouraged and
34+
will be discarded.
35+
3336
Follow these steps to contribute:
3437

3538
1. **Fork the Repository**.
@@ -108,10 +111,15 @@ removed whenever required by a new jump in major version.
108111
### Code Style
109112
110113
We follow [PEP 8](https://peps.python.org/pep-0008/) for Python code style.
111-
You can run a linter to check your code:
114+
You can run a linter to check your code. The dev dependencies of **tda-mapper**
115+
include `black` and `isort` to help you manage that.
116+
117+
```bash
118+
black .
119+
```
112120
113121
```bash
114-
flake8
122+
isort .
115123
```
116124
117125
### Documentation
@@ -123,6 +131,7 @@ To build the documentation locally:
123131
124132
```bash
125133
cd docs
134+
make clean
126135
make html
127136
```
128137

0 commit comments

Comments
 (0)