From 95c8337b53bc65d122e35b74790ff15316baabe5 Mon Sep 17 00:00:00 2001 From: Andreas Wallner <20979738+andreasWallnerIFX@users.noreply.github.com> Date: Mon, 23 Sep 2024 21:30:36 +0200 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 26 +++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .../feature-request---question.md | 20 ++++++++++++++ .github/pull_request_template.md | 14 ++++++++++ 4 files changed, 61 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request---question.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..328f22a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,26 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Run '....' +3. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**SVD file (snippet) and/or code snippet** +If applicable, add an SVD/code snippet that shows the issue. You can also attach an SVD file if necessary/helpful. + +**Additional context** +Add any other context about the problem here. (i.e. specific Rust version etc.) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..ec4bb38 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request---question.md b/.github/ISSUE_TEMPLATE/feature-request---question.md new file mode 100644 index 0000000..52fc7e6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request---question.md @@ -0,0 +1,20 @@ +--- +name: Feature request / Question +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..dddae69 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,14 @@ +## Description +Provide the information we need to review your PR. What problem does the pull request solve? +For larger issues think about chatting with us first (e.g. in a "Question" issue). + +## Related Issue +If you opened an issue before creating the PR, point to it here. + +## Context +What do we need to know about your development environment, tools, target, and so on. Screenshots are always helpful if there is a UI element to this PR. + +--- please keep the agreement as part of the PR text --- +By creating this pull request you agree to the terms in CONTRIBUTING.md. +https://github.com/Infineon/svd2pac/blob/main/CONTRIBUTING.md +CONTRIBUTING.md also tells you what to expect in the PR process.