Skip to content

Latest commit

 

History

History
25 lines (16 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

25 lines (16 loc) · 1.22 KB

Contributing 💡

Explainable CNN is created with the help of what is available for free on the internet and hence it will always be available for free. This makes it an open source project and everyone are welcome to contribute to different aspects of the project.

You may want to contribute on adding new shapes, fixing bugs, improving/refactoring code etc.

If you can help us with these, please don't hesitate to open a pull request or an issue. If you want to know about how to create pull request, then please refer to this youtube playlist.

Python Code Style Checking

We use pycodestyle for checking the consistency in code quality throughout the source code. You may want to run following command after adding the code for contribution.

$ pip install pycodestyle
$ pycodestyle .

Unit Testing using PyTest

We use pytest to write test cases to check the consistency and backward compatibility of the project. You may want to execute following command to run unit testing.

$ pip install pytest
$ pytest tests/