From 67f1c2f301b53d0007fc5a26ca4cffc0d35dcd36 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Magnus=20Gro=C3=9F?= Date: Fri, 4 Aug 2023 00:52:01 +0200 Subject: [PATCH] Add issue template --- .github/CONTRIBUTING.md | 19 +++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.yml | 24 ++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + 3 files changed, 44 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..609b988 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Contributing + +## Issues and bug reports +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. + +## Development +Code contributions are much welcomed and appreciated. +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. + +### Submitting Patches +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. + +### Developer's Certificate of Origin +By making a contribution to this project, I certify that: + +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 +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 +3. The contribution was provided directly to me by some other person who certified (1), (2) or (3) and I have not modified it. +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. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..72d1c04 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,24 @@ +name: Guided bug report +description: "File a bug report. If you know what you are doing, feel free to open a blank issue below." +body: + - type: textarea + id: description + attributes: + label: Describe the bug + placeholder: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: To reproduce + placeholder: Steps to reproduce the behavior. + validations: + required: false + - type: textarea + id: expected + attributes: + label: Expected behavior + placeholder: A clear and concise description of what you expected to happen. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..0086358 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true