Skip to content

Latest commit

 

History

History
10 lines (9 loc) · 703 Bytes

CONTRIBUTING.rst

File metadata and controls

10 lines (9 loc) · 703 Bytes

Contributing

  1. Clone the repository with git clone git@github.com:argaen/aiocache.git
  2. Install dependencies with make install-dev
  3. Make a change (means writing code, tests without reducing coverage and docs)
  4. Ensure syntax is correct with make lint. If there are errors, you can format the code with make format
  5. Ensure all tests pass with make test. For fast iterations, use make unit which will build just the unit tests. You will need docker and docker-compose to be able to pass acceptance and functional tests.
  6. Ensure documentation is OK with sphinx-autobuild docs/ docs/_build/html/
  7. Make the PR in Github (you must have a fork of your own)