mirror of
https://github.com/stefanpejcic/openpanel
synced 2025-06-26 18:28:26 +00:00
28 lines
2.0 KiB
Markdown
28 lines
2.0 KiB
Markdown
# Contributing
|
|
|
|
We enthusiastically encourage contributions of all sorts to our repository, from correcting typos, to improving checks or adding new ones.
|
|
|
|
### Reporting Issues
|
|
|
|
This section guides you through submitting an issue for the Marketplace Partners. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related reports :mag_right:.
|
|
|
|
When you are reporting an issue, please [include as many details as possible](#how-do-i-submit-a-good-bug-report).
|
|
|
|
> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
|
|
|
|
#### Before Submitting An Issue
|
|
* **Check the [current issues](https://github.com/digitalocean/marketplace-partners/issues)**.
|
|
|
|
#### How Do I Submit A (Good) Issue?
|
|
|
|
Issues are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue and provide the following information listed below.
|
|
|
|
Explain the problem and include additional details to help maintainers reproduce the problem:
|
|
|
|
* **Use a clear and descriptive title** for the issue to identify the problem.
|
|
* **Describe the exact steps which reproduce the problem** in as many details as possible. When listing steps, **don't just say what you did, but explain how you did it**.
|
|
* **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
|
|
* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
|
|
* **Explain which behavior you expected to see instead and why.**
|
|
* **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem.
|