mirror of
https://github.com/xoofx/markdig.git
synced 2026-02-03 21:36:36 +00:00
37 lines
1.7 KiB
Markdown
37 lines
1.7 KiB
Markdown
# 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:
|