This is contribution guide for pykakasi project. You are welcome to send a Pull-Request, reporting bugs and ask questions.
- Project owner: Hiroshi Miura
- Slack chat: Join to https://pykakasi.slack.com/
- Bug Tracker: Github issue Tracker
- Status: alpha
- Activity: low
Every report to github issue tracker should be triaged whether it is bug, question or invalid.
Here is small amount rule when you want to send patch the project;
- every proposal for modification should send as 'Pull Request'
- each pull request can consist of multiple commits.
- you are encourage to split modifications to individual commits that are logical subpart.
Pykakasi project configured to use AppVeyor, Travis-CI and CoverAlls for regression test. You can see test results on badge and see details in a web page linked from badge. The results are also notified in gitter channel.
To run test, you can do it as ordinary:
python setup.py test
or:
pytest
You can also run test using pyenv/tox with versions:
pyenv install 2.7.13 pyenv install 3.5.5 pyenv install 3.6.4 pyenv local 2.7.13, 3.5.5, 3.6.4 tox