Skip to content

Contribution Guidelines

If you’re reading this, you’re probably interested in contributing to kiss-headers. Thank you very much! Open source projects thrive based on the support they receive from others, and the fact that you’re even considering contributing to this project is very generous of you.

Questions

The GitHub issue tracker is for bug reports and feature requests. Questions are allowed only when no answer are provided in docs.

Good Bug Reports

Please be aware of the following things when filing bug reports:

  1. Avoid raising duplicate issues. Please use the GitHub issue search feature to check whether your bug report or feature request has been mentioned in the past. Duplicate bug reports and feature requests are a huge maintenance burden on the limited resources of the project. If it is clear from your report that you would have struggled to find the original, that’s ok, but if searching for a selection of words in your issue title would have found the duplicate then the issue will likely be closed extremely abruptly.
  2. When filing bug reports about exceptions or tracebacks, please include the complete traceback. Partial tracebacks, or just the exception text, are not helpful. Issues that do not contain complete tracebacks may be closed without warning.

  3. Make sure you provide a suitable amount of information to work with. This means you should provide:

  4. Guidance on how to reproduce the issue. Ideally, this should be a small code sample that can be run immediately by the maintainers. Failing that, let us know what you’re doing, how often it happens, what environment you’re using, etc. Be thorough: it prevents us needing to ask further questions.

  5. Tell us what you expected to happen. When we run your example code, what are we expecting to happen? What does “success” look like for your code?
  6. Tell us what actually happens. It’s not helpful for you to say “it doesn’t work” or “it fails”. Tell us how it fails: do you get an exception? A None answer? How was the actual result different from your expected result?
  7. Tell us what version of kiss-headers you’re using, and how you installed it. Different versions of kiss-headers behave differently and have different bugs.

If you do not provide all of these things, it will take us much longer to fix your problem. If we ask you to clarify these and you never respond, we will close your issue without fixing it.