mirror of
https://github.com/rlespinasse/shortify-git-revision.git
synced 2026-05-17 10:15:27 +00:00
33 lines
1.5 KiB
Markdown
33 lines
1.5 KiB
Markdown
# How to contribute to Shortify Git Revision
|
|
|
|
## Did you find a bug
|
|
|
|
* **Do not open up a GitHub issue if the bug is a security vulnerability**, and instead to refer to our [security policy][1].
|
|
|
|
* **Ensure the bug was not already reported** by searching on GitHub under [Issues][2].
|
|
|
|
* If you're unable to find an open issue addressing the problem, [open a 'Bug' issue][4].
|
|
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.
|
|
|
|
## 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.
|
|
|
|
## Do you intend to add a new feature or change an existing one
|
|
|
|
* Suggest your change by [opening a 'Feature request' issue][5]
|
|
|
|
## Do you have questions about the source code
|
|
|
|
* [open an issue][3] with your question.
|
|
|
|
Thanks!
|
|
|
|
[1]: https://github.com/rlespinasse/shortify-git-revision/security/policy
|
|
[2]: https://github.com/rlespinasse/shortify-git-revision/issues
|
|
[3]: https://github.com/rlespinasse/shortify-git-revision/issues/new
|
|
[4]: https://github.com/rlespinasse/shortify-git-revision/issues/new?assignees=&labels=bug&template=bug_report.md&title=
|
|
[5]: https://github.com/rlespinasse/shortify-git-revision/issues/new?assignees=&labels=enhancement&template=feature_request.md&title= |