Every contributor is welcome, regardless of their programming experience, if any. There are several ways you can contribute to this project, here is a not exhaustive list:
The prefered way to report any bug is opening an issue in the project's Github repo.
Pull requests are welcome. If you want to contribute code to solve an open issue:
- Add a comment to tell everyone you are working on the issue.
- If an issue has someone assigned it means that person is already working on it.
- Fork the project.
- Create a topic branch based on main.
- Commit there your code to solve the issue.
- Make sure all test are passing (and add specs to test any new feature if needed).
- Follow the code styles and practices already in place. If in doubt, follow PEP8.
- Open a pull request to the main repository mentioning the issue you are addressing.
In the rush of time sometimes things get messy, you can help us cleaning things up:
- implementing pending tests
- increasing code coverage
- improving code quality
- updating dependencies
- making code consistent
- If you think there's a feature missing, or find a bug, create an issue (make sure it has not already been reported).
- You can also help promoting PST talking about it in your work groups or social networks.
- Improving the docs is always needed, documenting use cases or writing tutorials are great additions.
- Try to use a descriptive and to-the-point title
- Is a good idea to include some of these sections:
- Steps to reproduce the bug
- Expected behaviour/response
- Actual response
- Sometimes it is also helpful if you mention your operating system or shell.
PyKOALA is released under the 3-Clause BSD License.
Thanks! ❤️ 🔭 ❤️