Thank you for considering to contribute to this project!
It is open for discussion to change anything regarding contributing, linting, workflow etc. at any point in time.
All development is done using github.
If you want to ask a question, need a new feature, found gaps in the documentation, found a bug, found code that can be refactored etc. you first have to start with creating an Issue.
Please check if there already is an issue for your problem.
Right now there are no specific guidelines for Issues, other than that their name and description should include enough details so that everyone knows what the issue is about.
Great Bug Reports tend to have:
- A quick summary
- Steps to reproduce (be specific and try to give sample code if possible)
- What you expected would happen
- What actually happens
- Additional info (eg. why you think this might be happening, or workarounds you tried that did/did not work)
By contributing to this project, you agree that your contributions will be licensed under its MIT License.