Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 2.48 KB

SUPPORT.md

File metadata and controls

51 lines (36 loc) · 2.48 KB

Where should I ask my questions?

ℹ️ This project has a Code of Conduct. By interacting with this repository or community, you agree to abide by its terms.

Hi! 👋

We’re excited that you’re using this tool and we’d love to help. To help us help you, please read through the following guidelines. Please understand that people involved with this project often do so for fun, next to their day job; you are not entitled to free customer service.

Asking Quality Questions

Help us help you!

Spending time framing a question and adding support links or resources makes it much easier for us to help. It’s easy to fall into the trap of asking something too specific when you’re close to a problem. Then, those trying to help you out have to spend a lot of time asking additional questions to understand what you are hoping to achieve.

Spending the extra time upfront can help save everyone time in the long run.

  • Try to define what you need help with:
    • Is there something in particular you want to do?
    • What problem are you encountering and what steps have you taken to try and fix it?
    • Is there a concept you’re not understanding?
  • Learn about the rubber duck debugging method.
  • Avoid falling for the XY problem.
  • Search on GitHub to see if a similar question has been asked.
  • If possible, provide sample code or a repository that demonstrates the problem.
  • The more time you put into asking your question, the better we can help you.

How to Report a Bug or Request an Enhancement

This project manages bugs and enhancements using the GitHub issue tracker. The issue templates will guide you on making an effective report.

How to Report a Security Vulnerability

If you think you've found a potential vulnerability in this project, please directly message @drachenpapa to responsibly disclose it. We will address the issue as soon as possible. We appreciate your efforts to disclose the issue privately and give us an opportunity to fix it before disclosing it publicly.

Contributions

See our contributing guidelines on how to contribute.

License

This project is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0). © Henning Steinberg (@drachenpapa)