First off, thank you for considering contributing to inscriptis. There are many ways how you can contribute to the project and these guidelines aim at supporting you in doing so.
- Reporting bugs and seeking support
- Suggesting enhancements
- Pull requests (contributing code)
- Python style guide
Bugs and support requests are tracked as GitHub issues.
To create an effective and high quality ticket, please include the following information in your ticket:
- Use a clear and descriptive title for the issue to identify the problem. This also helps other users to quickly locate bug reports that affect them.
- Describe the exact steps necessary for reproducing the problem including at least information on
- the affected URL
- the command line parameters or function arguments you used
- What would have been the expected behavior?
- Describe the observed behavior.
- Provide any additional information which might be helpful in reproducing and/or fixing this issue.
Enhancements are also tracked as GitHub issues and should contain the following information:
- A clear and descriptive title helps other people to identify enhancements they like, so that they can also add their thoughts and suggestions.
- Provide a step-by-step description of the suggested enhancement.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Ensure that your code complies with our Python style guide.
- Write a unit test that covers your new code and put it into the
./testsdirectory. - Execute
tox .in the project's root directory to ensure that your code passes the static code analysis, coding style guidelines and security checks. - In addition, please document any new API functions in the Inscriptis documentation.
Inscriptis code should comply to
- the PEP8 Style Guide for Python Code, and
- to the Google Python Style Guide
Please also ensure that
- functions are properly documented with docstrings that comply to the Google Python Style Guide, and
- any new code is covered by unit tests.