We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.
Before you submit a pull request, check that it meets these guidelines:
-
Fork the repository. Create a new branch from the master branch.
-
Make a pull request from your new branch to the master branch of the original keras-autodoc repo. Give your pull request a meaningful name.
-
Include "resolves #issue_number" in the description of the pull request if applicable and briefly describe your contribution.
-
For the case of bug fixes, add new test cases which would fail before your bug fix.
This project tries to closely follow the official Python Style Guide detailed in PEP8. We use Flake8 to enforce it. The docstrings follow the Google Python Style Guide.
Pytest is used to write the unit tests.
You should test your code by writing unit testing code in tests directory.
The testing file name should be the .py file with a prefix of test_ in the corresponding directory,
e.g., the name should be test_layers.py if the code of which is to test layer.py.
If you have Docker, you can easily run all tests without any setup by running docker build -f tests/Dockerfile . from the root directory.
You can make git run flake8 before every commit automatically. It will make you go faster by
avoiding pushing commits which are not passing the flake8 tests. To do this,
open .git/hooks/pre-commit with a text editor and write flake8 inside. If the flake8 test doesn't
pass, the commit will be aborted.
All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.
This project follows Google's Open Source Community Guidelines.