Skip to content

Commit 67f1c2f

Browse files
committed
Add issue template
1 parent 932c288 commit 67f1c2f

File tree

3 files changed

+44
-0
lines changed

3 files changed

+44
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Contributing
2+
3+
## Issues and bug reports
4+
When filing a bug report, please state clearly what the problem is, i.e. explain which behaviour is observed and which behaviour is expected instead.
5+
6+
## Development
7+
Code contributions are much welcomed and appreciated.
8+
Please make sure that the code is formatted according to the `.clang-format` file in the root of the repository. If you have not configured your editor to format automatically, you can use the [format-code.sh](/scripts/format-code.sh) script or `git clang-format`, before committing.
9+
10+
### Submitting Patches
11+
You can either submit your changes as a pull request on Github or send them via email to me. In the latter case make sure that your email client does not break the formatting of your patch, I recommend using `git send-email` for this.
12+
13+
### Developer's Certificate of Origin
14+
By making a contribution to this project, I certify that:
15+
16+
1. The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
17+
2. The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
18+
3. The contribution was provided directly to me by some other person who certified (1), (2) or (3) and I have not modified it.
19+
4. I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Guided bug report
2+
description: "File a bug report. If you know what you are doing, feel free to open a blank issue below."
3+
body:
4+
- type: textarea
5+
id: description
6+
attributes:
7+
label: Describe the bug
8+
placeholder: A clear and concise description of what the bug is.
9+
validations:
10+
required: true
11+
- type: textarea
12+
id: reproduce
13+
attributes:
14+
label: To reproduce
15+
placeholder: Steps to reproduce the behavior.
16+
validations:
17+
required: false
18+
- type: textarea
19+
id: expected
20+
attributes:
21+
label: Expected behavior
22+
placeholder: A clear and concise description of what you expected to happen.
23+
validations:
24+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true

0 commit comments

Comments
 (0)