Skip to content

Commit

Permalink
Update README.md (#24)
Browse files Browse the repository at this point in the history
* Update README.md

* Update setup.py
  • Loading branch information
hasnainroopawalla authored Jan 2, 2022
1 parent 1412e63 commit 0fb6db3
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 16 deletions.
23 changes: 8 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,22 +75,15 @@ $ pip install -r requirements.txt
## ✏️ Contributing <a name = "contributing"></a>

1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository.
2. Install the necessary housekeeping dependencies:
```
$ pip install pre-commit mypy pytest
```
3. Commit and push your changes to your own branch.
4. Run these housekeeping checks locally (required for the CI to pass):-
- Run [pre-commit](https://pre-commit.com/):
2. Commit and push your changes to your own branch.
3. Install and run the necessary housekeeping dependencies ([pre-commit](https://pre-commit.com/), [mypy](https://github.com/python/mypy) and [pytest](https://docs.pytest.org)):
```
$ pip install pre-commit mypy pytest
```
4. Run these housekeeping checks locally and make sure all of them succeed (required for the CI to pass):-
```
$ pre-commit run -a
$ mypy .
$ pytest
```
- Run [mypy](https://github.com/python/mypy):
```
$ mypy .
```
- Run [pytest](https://docs.pytest.org):
```
$ pytest
```
5. Open a Pull Request and I'll review it.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

setup(
name="showml",
version="1.5.7",
version="1.5.8",
packages=find_packages(exclude="tests"),
description="A Python package of Machine Learning Algorithms implemented from scratch",
long_description=long_description,
Expand Down

0 comments on commit 0fb6db3

Please sign in to comment.