Development

Getting Involved

The paat project welcomes help in the following ways:

• Making Pull Requests for code, tests or documentation.

• Commenting on open issues and pull requests.

• Helping to answer questions in the issue section.

• Creating feature requests or adding bug reports in the issue section.

Workflow

1. Fork this repository on Github. From here on we assume you successfully forked this repository to https://github.com/yourname/paat.git

2. Get a local copy of your fork and install the package with Python Poetry <https://python-poetry.org/> by running

git clone https://github.com/yourname/paat.git
cd paat
poetry install

3. Add code, tests or documentation.

4. Test your changes locally by running within the root folder (paat/)

   poetry run pytest --cov=paat
   

5. Add and commit your changes after tests run through without complaints.

   git add -u
   git commit -m 'fixes #42 by posing the question in the right way'
   

   You can reference relevant issues in commit messages (like #42) to make GitHub link issues and commits together, and with phrase like “fixes #42” you can even close relevant issues automatically.

6. Push your local changes to your fork:

   git push git@github.com:yourname/paat.git
   

7. Open the Pull Requests page at https://github.com/yourname/paat/pulls and click “New pull request” to submit your Pull Request to https://github.com/trybnetic/paat.

Licensing

All contributions to this project are licensed under the MIT license. Exceptions are explicitly marked. All contributions will be made available under MIT license if no explicit request for another license is made and agreed on.