-
-
Notifications
You must be signed in to change notification settings - Fork 456
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #674 from wbaldoumas/contriuting-docs
Add Contributing Docs
- Loading branch information
Showing
2 changed files
with
40 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# How to Contribute | ||
|
||
Thanks for your interest in contributing to `Markdig`! Here are a few general guidelines on contributing and | ||
reporting bugs that we ask you to review. Following these guidelines helps to communicate that you respect the time of | ||
the contributors managing and developing this open source project. | ||
|
||
## Reporting Issues | ||
|
||
Before reporting a new issue, please ensure that the issue was not already reported or fixed by searching through our | ||
[issues list](https://github.com/xoofx/markdig/issues). | ||
|
||
When creating a new issue, please be sure to include a **title and clear description**, as much relevant information as | ||
possible, and, if possible, a test case. | ||
|
||
## Sending Pull Requests | ||
|
||
Before sending a new pull request, take a look at existing pull requests and issues to see if the proposed change or fix | ||
has been discussed in the past, or if the change was already implemented but not yet released. | ||
|
||
We expect new pull requests to include tests for any affected behavior, and, as we follow semantic versioning, we may | ||
reserve breaking changes until the next major version release. | ||
|
||
## Other Ways to Contribute | ||
|
||
We welcome anyone that wants to contribute to `Markdig` to triage and reply to open issues to help troubleshoot | ||
and fix existing bugs. Here is what you can do: | ||
|
||
- Help ensure that existing issues follows the recommendations from the _[Reporting Issues](#reporting-issues)_ section, | ||
providing feedback to the issue's author on what might be missing. | ||
instructions and code samples. | ||
- Review existing pull requests, and testing patches against real existing applications that use `Markdig`. | ||
- Write a test, or add a missing test case to an existing test. | ||
|
||
Thanks again for your interest on contributing to `Markdig`! | ||
|
||
:heart: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters