Thank you for your interest in Markdown Scanner!
You can contribute to Markdown Scanner in these ways:
- Create issues based on bugs you've found when using API Doctor.
- Create issues based on desired but missing functionality for API Doctor.
- Contribute additional unit test cases that increase code coverage and validation of key scenarios for API Doctor. Tests should always pass on the latest master codebase.
- Contribute bug fixes and unit tests that validate the bug fix.
- Contribute new functionality and appropriate test scenarios.
If our automated process determines that the pull request is significant, you will be required to sign the Contribution License Agreement (CLA) before the pull request can be reviewed.
Signing the Contribution License Agreement (CLA) does not grant you rights to commit to the main repository, but it does mean we can review your pull request and consider your contributions to the project.
You can view, download, and/or sign the Contribution License Agreement. This is only required if you wish to have your pull request considered.
For details of how to use GitHub to contribute to a project most effectively, see the Contributing to open source articles.
To make the contribution process as seamless as possible for you, follow this procedure.
- Fork the repository into your own account.
- Create a new branch for the bug/feature you are working on.
- Implement the new functionality / bug fixes and add approriate test scenarios.
- Submit a pull request to the main repository master branch.
Limit each branch to a single concept/feature to streamline the workflow and reduce the chance of merge conflicts.
Multiple small bug fixes may be combined in a single pull request, although if they become significant you may be requested to separate them into multiple branches / requests.