Skip to content

Latest commit

 

History

History
75 lines (45 loc) · 4.74 KB

CONTRIBUTING.md

File metadata and controls

75 lines (45 loc) · 4.74 KB
Raw

Contributor's Guide

Below is the guidance for how to report issues, propose new features, and submit contributions via Pull Requests.

🐛 Before you start, file an issue

Please follow this simple rule to help me stop any unnecessary effort and frustration, so we all can ensure an efficient and effective use of everyone's time - yours, mine, and the time of other community members. Always keep in mind, someone else may have already done the work.

If you have a question, or do you think you have discovered an issue, or would you like to propose a new feature? T2hen find/file an issue before starting work. This will help me to provide feedback, avoid unnecessary work, and help you to get started.

❗ For security issues please have a look at the Security Policy ❗

🔎 Search existing issues first

Before filing a new issue, search existing open and closed issues first. Perhaps someone else has found the problem you are seeing, and someone may be working on or have already contributed a fix. We all have limited time, so please help me in my fight against the duplication of work.

If no existing item describes your issue/feature, great - please file a new issue.

Please include as many information as possible in your issue. The more information you provide, the more likely your issue/ask will be understood, accepted, and implemented.

📝 File a new Issue

  • You found a security issue and you want to report it? Please have a look at the Security Policy.
  • You have found a bug and you want to report it? Please file a new issue with the tag "bug".
  • You have found something critical, perhaps a bug where data can be lost, etc.? Please file a new issue with the tags "critical" and "bug".
  • You have got a great idea for a new feature? Please file a new issue with the tag "feature".
  • You have a question that you do not see answered in docs, videos, etc.? Please file a new issue with the tag "question".
  • You found an existing issue that describes yours? Great - please upvote (:+1:) and add additional commentary / info / repro-steps / etc.

💯 Complete the template

Please include as many information as possible in your issue. The more information you provide, the more likely your issue/ask will be understood, accepted, and implemented.

  • Do not assume somebody other than you is an expert in setting up your environment and do not assume somebody else is an expert in your workflow. Please tell me as many details you can, so I can help you as good as possible!
  • What steps are needed to reproduce the issue? Assume I love to read repro steps. As many detail as you can stand is probably barely enough detail for me.
  • I prefer error message text where possible, or screenshots of errors if the error text cannot be captured.
  • If you intend to implement the fix/feature yourself, please say so! If you do not indicate you want to contribute, I assume that the issue is mine to solve.

👍 Do not post "+1" comments

Please do not post "+1", "me too", or similar comments - these comments just add noise to an issue.

If you do not have any additional information to add but would like to indicate that you are affected by the issue, upvote the original issue by clicking its 😃-button and hitting 👍 (+1) icon. This way it is much easier to measure how impactful an issue is.

🇺🇸 Preferred Language

I prefer all communications to be in English. This helps to ensure that vulnerabilities are understood and can be addressed quickly.

👨‍💻 Development

🧰 Fork, Clone, Branch and Create your PR

Once you have filed an issue and discussed your proposed feature/fix, it is time to start development:

  1. Fork the repo if you have not already.
  2. Clone your fork locally.
  3. Create & push a branch.
  4. Create a Draft Pull Request.
  5. Work on your changes.

🤓 Code Review

When you would like me to look, (even if the work is not yet fully complete), mark the Pull Request as 'Ready for Review' so that I can review your work and provide comments, suggestions, and request changes. I would like to encourage you to use the Pull Request as tool to start a conversation around your ideas and recruit people to help if necessary. It may take several cycles, but the result will be solid, testable, conformant code that is safe to merge.

🧩 Merge

Once your code has been reviewed and approved, it will be merged. Once merged, your Pull Request will be automatically closed.

🎈 Thank you

Thank you in advance for your contribution!