Skip to content

Commit ba77371

Browse files
fixed CONTRIBUTING.md and requirements.txt
1 parent 9f1f80f commit ba77371

File tree

2 files changed

+2
-5
lines changed

2 files changed

+2
-5
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -121,14 +121,10 @@ When you're ready to contribute code to address an open issue, please follow the
121121

122122
Our continuous integration (CI) testing runs [a number of checks](https://github.com/cheshire-cat-ai/cheshire-cat-api/actions) for each pull request on [GitHub Actions](https://github.com/features/actions). You can run most of these tests locally, which is something you should do *before* opening a PR to help speed up the review process and make it easier for us.
123123

124-
Our CI also uses [`flake8`](https://github.com/cheshire-cat-ai/cheshire-cat-api/tree/main/tests) to lint the code base and [`mypy`](http://mypy-lang.org/) for type-checking. You should run both of these next with
124+
Our CI also uses [`flake8`](https://github.com/cheshire-cat-ai/cheshire-cat-api/tree/main/tests) to lint the code base. You should run it with
125125

126126
flake8 .
127127

128-
and
129-
130-
mypy .
131-
132128
We also strive to maintain high test coverage, so most contributions should include additions to [the unit tests](https://github.com/cheshire-cat-ai/cheshire-cat-api/tree/main/tests). These tests are run with [`pytest`](https://docs.pytest.org/en/latest/), which you can use to locally run any test modules that you've added or changed.
133129

134130
For example, if you've fixed a bug in `cheshire-cat-api/a/b.py`, you can run the tests specific to that module with

requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ setuptools >= 21.0.0
33
urllib3 >= 1.25.3, < 2.1.0
44
pydantic >= 1.10.5, < 2
55
aenum >= 3.1.11
6+
websocket-client>=1.6.1

0 commit comments

Comments
 (0)