Skip to content

Latest commit

 

History

History
30 lines (17 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

30 lines (17 loc) · 1.72 KB
Raw

Welcome to ez-docs contributing guide

Thank you for investing your time in contributing to our project! Any contribution you make may be reflected on ez-docs

Read our Code of Conduct to keep our community approachable and respectable.

How to contribute to ez-docs

Did you find a bug?

  • Do not open up a GitHub issue if the bug is a security vulnerability in ez-docs, and instead to refer to our security policy.

  • Ensure the bug was not already reported by searching on GitHub under Issues.

If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behaviour that is not occurring.

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.
  • Before submitting, please read the our Standards guide to know more about coding conventions and benchmarks.

Did you fix whitespace, format code, or make a purely cosmetic patch?

Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of ez-docs will generally not be accepted.

ez-docs is a volunteer effort. We encourage you to pitch in and join the team!

Thanks! - ez-docs Team -