DannyBen/bashly

View on GitHub
CONTRIBUTING.md

Summary

Maintainability
Test Coverage
# How to contribute

Thank you for reading this page, we would love to hear how you think bashly can
be improved. Out of respect for your time, this guide will be succinct.

| If you want to...                | then
|----------------------------------|-------
| report a **bug**                 | open a [Bug Report issue][bug-report]
| suggest a **feature**            | open a [Feature Request issue][feature-request] or start an [Ideas discussion][discussions-ideas]
| suggest an **improvement**       | open a [Feature Request Issue][feature-request] or start an [Ideas discussion][discussions-ideas]
| ask a **question**               | start a [Q&A discussion][discussions-qna]
| **share** how you use bashly     | start a [Show and Tell discussion][discussions-show]
| contribute **code**              | open an [issue][issues] or start a [discussion][discussions] first and let us know you are interested in coding it yourself
| report a **documentation** issue | open a [Documentation Issue][documentation-issue]
| fix a **documentation** error    | create a pull request in the [bashly-book repository][bashly-book-repo]
| do **something else**            | start a [discussion][discussions]



[issues]: https://github.com/DannyBen/bashly/issues/new/choose
[bug-report]: https://github.com/DannyBen/bashly/issues/new?labels=bug&template=bug_report.md
[feature-request]: https://github.com/DannyBen/bashly/issues/new?&labels=enhancement&template=feature_request.md
[documentation-issue]: https://github.com/DannyBen/bashly/issues/new?&labels=documentation&template=documentation_issue.md

[discussions]: https://github.com/DannyBen/bashly/discussions
[discussions-qna]: https://github.com/DannyBen/bashly/discussions/categories/q-a
[discussions-ideas]: https://github.com/DannyBen/bashly/discussions/categories/ideas
[discussions-show]: https://github.com/DannyBen/bashly/discussions/categories/show-and-tell

[bashly-book-repo]: https://github.com/DannyBen/bashly-book