Contributing Guide
Contributions are welcome, and greatly appreciated! This page is only a guide of the best practices of contributing code to AutoKeras. The best way to contribute is to join our community by reading this. We will get you started right away.
Follow the tag of good first issue for the issues for beginner.
Pull Request Guide
-
Is this the first pull request that you're making with GitHub? If so, read the guide Making a pull request to an open-source project.
-
Include "resolves #issue_number" in the description of the pull request if applicable. Briefly describe your contribution.
-
Submit the pull request from the first day of your development and create it as a draft pull request. Click
ready for review
when finished and passed the all the checks. -
For the case of bug fixes, add new test cases which would fail before your bug fix.
Setup Environment
virtualenv
Install Virtualenvwrapper.
Create a new virtualenv named ak
based on python3.
mkvirtualenv -p python3 ak
Installation
Clone the repo. Go to the repo directory. Run the following commands.
workon ak
pip install -e ".[tests]"
pip uninstall autokeras
add2virtualenv .
Run Tests
Activate the virtualenv. Go to the repo directory Run the following lines to run the tests.
Run all the tests.
pytest tests
Run all the unit tests.
pytest tests/autokeras
Run all the integration tests.
pytest tests/integration_tests
Code Style
Option 1: Automatic
It automatically formats the code every time you commit.
To setup:
1. Install Docker.
2. Run cd .git/hooks && ln -s -f ../../shell/pre-commit.sh pre-commit
from the repo directory.
Option 2: Manually
You can run the following manually every time you want to format your code.
1. Run shell/format.sh
to format your code.
2. Run shell/lint.sh
to check.
Docstrings
Docstrings should follow our style. Just check the style of other docstrings in AutoKeras.