Thank you for reading this and for considering to contribute to this project! This guide gives some hints on how to make the process as smooth and enjoyable as possible for everyone involved. Please try to follow them, but don't worry about them too much if anything is unclear or seems daunting. In case of doubt apply a healthy dose of common sense.
Found a bug? Noticed changes in the deSEC DNS API or the DNS world that this projects does not yet support? Had an idea for a quality-of-life feature? Please open an issue.
However, before reporting a bug, please check that you are using the latest version. If you are not, see if updating fixes the problem.
If you want to send some code or documentation changes, please submit them as a pull request. Please follow the coding conventions (below) and make sure all of your commits are atomic (one cleanly separable change per commit). Similarly, pull requests should only contain isolated changes for a single bug fix or feature implementation. Do not refactor or reformat code that is unrelated to the change.
Before making large or complex changes, please open an issue to discuss the best approach to the problem.
To keep the code consistent and readable, we use the following conventions:
- Adhere to PEP-8, with a line length limit of 99 characters.
- Format the code using
ruff format(orblack). - Use Google-style docstrings.
- Use PEP-484 type annotations.
By contributing to this project, you agree that your contribution will be licensed under the license specified in the LICENSE file.