Skip to content

Commit 4ffcede

Browse files
committed
add contributing guidelines and documentation issue template
1 parent b1b21a4 commit 4ffcede

File tree

2 files changed

+42
-0
lines changed

2 files changed

+42
-0
lines changed
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
name: Documentation Issue
3+
about: Report an issue with the documentation or with the examples
4+
title: ''
5+
labels: documentation
6+
assignees: ''
7+
8+
---
9+
10+
### URL
11+
12+
### Description

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# How to contribute
2+
3+
Thank you for reading this page, we would love to hear how you think bashly can
4+
be improved. Out of respect for your time, this guide will be succinct.
5+
6+
| If you want to... | then
7+
|----------------------------------|-------
8+
| report a **bug** | open a [Bug Report issue][bug-report]
9+
| suggest a **feature** | open a [Feature Request issue][feature-request] or start an [Ideas discussion][discussions-ideas]
10+
| suggest an **improvement** | open a [Feature Request Issue][feature-request] or start an [Ideas discussion][discussions-ideas]
11+
| ask a **question** | start a [Q&A discussion][discussions-qna]
12+
| **share** how you use bashly | start a [Show and Tell discussion][discussions-show]
13+
| contribute **code** | open an [issue][issues] or start a [discussion][discussions] first and let us know you are interested in coding it yourself
14+
| report a **documentation** issue | open a [Documentation Issue][documentation-issue]
15+
| fix a **documentation** error | create a pull request in the [bashly-book repository][bashly-book-repo]
16+
| do **something else** | start a [discussion][discussions]
17+
18+
19+
20+
[issues]: https://github.com/DannyBen/bashly/issues/new/choose
21+
[bug-report]: https://github.com/DannyBen/bashly/issues/new?labels=bug&template=bug_report.md
22+
[feature-request]: https://github.com/DannyBen/bashly/issues/new?&labels=enhancement&template=feature_request.md
23+
[documentation-issue]: https://github.com/DannyBen/bashly/issues/new?&labels=documentation&template=documentation_issue.md
24+
25+
[discussions]: https://github.com/DannyBen/bashly/discussions
26+
[discussions-qna]: https://github.com/DannyBen/bashly/discussions/categories/q-a
27+
[discussions-ideas]: https://github.com/DannyBen/bashly/discussions/categories/ideas
28+
[discussions-show]: https://github.com/DannyBen/bashly/discussions/categories/show-and-tell
29+
30+
[bashly-book-repo]: https://github.com/DannyBen/bashly-book

0 commit comments

Comments
 (0)