Skip to content

Latest commit

 

History

History
48 lines (26 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

48 lines (26 loc) · 2.52 KB

How to contribute to Unv

Did you find a bug?

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

  • Ensure the bug was not already reported by searching on GitHub under Issues(☝️ see above for issues tab).

  • If you're unable to find an open issue addressing the problem, open a new one(☝️ goto issues tab and tap new button). 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 behavior that is not occurring.

  • If possible, use the relevant bug report templates to create the issue. You will be asked to choose one

    • Feature request
    • Bug report

  • For more detailed information on submitting a bug report and creating an issue, visit Github issues guidelines.

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 Contributing to Unv(👉 this document) guide to know more about coding conventions.

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 Unv will generally not be accepted (read more about rationales behind this decision on another project).

Do you intend to add a new feature or change an existing one?

  • Suggest your change in the discussions(☝️ see above for discussions tab) and start writing code.

  • Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.

Do you have questions about the source code?

  • Ask any question about how to use Unv in the discussions(☝️ see above for discussions tab).

Do you want to contribute to the Unv documentation?

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

Thanks! ❤️ ❤️ ❤️

Unv Team