29 lines (28 loc) · 704 Bytes

Contributing guide

You need make and python in your $PATH

Clone repo from main branch:

git clone https://github.com/deknowny/demapi

Go to cloned repo

cd demapi

Install the repo locally with developing dependencies

make install-dev

Now you can develop new functional. You can create a .drafts/ directory for your drafts (added to .gitignore)

Run tests locally

make test

And if you want to suggest new changes: 5. Fork the repository 6. Push your changes to your fork 7. Create a pull request

There is also GitHub actions setup, and you can see coverage on different python versions and on different platforms.