Contributing

Test suite

Todo

Documentation

You can edit documents by modifying reStructuredText markup under docs directory. Before sending a Pull Request about documentation you can preview your modification as follows:

$ cd docs
$ make html

And then you can see the output with your browser. Open file file://...path/to/aiozk/docs/_build/html/index.html

Pull Request

Follow steps below to send a pull request to aiozk repository.

  1. Fork aiozk repository GitHub

  2. Make a change

  3. Run test code and check that every test passes

  4. Commit your modification (it would be better with clear and concise commit message)

  5. Push your local ref to your own repository forked from aiozk.

  6. Make a Pull Request