Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add contribution guidelines #20

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add contribution guidelines #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## How to contribute to Donut

#### **Did you find a bug?**

* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/plowteam/donut/issues).

* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/plowteam/donut/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, including your expected outcome vs your observed outcome.

* **Keep issues focused and easy to understand** by limiting discussion to the technical
problem only. An issue shouldn't take more than a few minutes for a person to read and
understand.

* Be aware that issues are limited to the scope of the original reported bug. If a new bug is found while
investigating an existing issue, a new issue should be opened.

#### **Did you write a patch that fixes a bug?**

* Open a new GitHub pull request with the patch.

* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ Contributions are always welcome, whether it's modifying source code to add new
features or bug fixes, documenting new file formats or simply editing some
grammar.

Please take a moment to read through the [contribution guidelines](./CONTRIBUTING.md).

You can also join the [Discord for development discussion]((https://discord.gg/xpdbWzG))
if you are unsure of anything.

Expand Down