From 69e213f048072fff7da5ce9073802387fd1ea0bd Mon Sep 17 00:00:00 2001 From: Zachariah Frank Date: Fri, 22 Mar 2024 17:20:43 +0100 Subject: [PATCH] docs(templates): move Issue and Pull Request templates from /docs so they can be used --- .github/ISSUE_TEMPLATE/1-feature-request.yml | 51 +++++++++ .github/ISSUE_TEMPLATE/2-bug-report.yml | 58 ++++++++++ .../ISSUE_TEMPLATE/3-vulnerability-report.yml | 48 +++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/pull_request_template.md | 24 +++++ docs/GIT_FLOW.md | 101 ------------------ 6 files changed, 182 insertions(+), 101 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/1-feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/2-bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/3-vulnerability-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/1-feature-request.yml b/.github/ISSUE_TEMPLATE/1-feature-request.yml new file mode 100644 index 00000000..c473a94b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-feature-request.yml @@ -0,0 +1,51 @@ +name: Feature request +description: Suggest an idea for this project +title: "[Feature]: " +body: + - type: textarea + id: summary + attributes: + label: General Summary + description: Please provide a general summary of the problem + placeholder: e.g. "The main issue is that..." + validations: + required: true + - type: textarea + id: change + attributes: + label: Suggested Change + description: Provide details on the suggested change + placeholder: e.g. "This new feature will allow users to update..." + validations: + required: true + - type: dropdown + id: breaking + attributes: + label: Is this Breaking? + description: Explain the behavior expected in this case + options: + - "Yes" + - "No" + validations: + required: true + - type: textarea + id: current_behavior + attributes: + label: Current Behavior + description: Explain what the current behavior is + validations: + required: true + - type: textarea + id: new_behavior + attributes: + label: New Behavior + description: Propose what the new behavior would be + validations: + required: true + - type: textarea + id: description + attributes: + label: Detailed Description + description: Please provide a more detailed description + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/2-bug-report.yml b/.github/ISSUE_TEMPLATE/2-bug-report.yml new file mode 100644 index 00000000..39e45073 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-bug-report.yml @@ -0,0 +1,58 @@ +name: Bug Report +description: Report a bug to improve Lens +title: "[Bug]: " +body: + - type: textarea + id: summary + attributes: + label: General Summary + description: Please provide a general summary of the problem + placeholder: e.g. "The main issue is that..." + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: Explain the behavior expected + placeholder: e.g. "The feature should do a, then b when you click c." + validations: + required: true + - type: textarea + id: current + attributes: + label: Current Behavior + description: Explain what the actual behavior is + placeholder: e.g. "The feature actually does x, y and shows error z." + validations: + required: true + - type: textarea + id: possible_solution + attributes: + label: Possible Solution + description: Suggest a possible fix for the bug + validations: + required: false + - type: textarea + id: reproduce + attributes: + label: Steps to Reproduce + description: Explain how to reproduce the problem + placeholder: e.g. "1. The first step to reproduce this error is to access the members area..." + validations: + required: true + - type: textarea + id: context + attributes: + label: Context (Environment) + description: Provide context on the setting and environment + placeholder: e.g. "This bug happened on a Windows 10 PC running the newest Google Chrome." + validations: + required: false + - type: textarea + id: description + attributes: + label: Detailed Description + description: Please provide a more detailed description + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/3-vulnerability-report.yml b/.github/ISSUE_TEMPLATE/3-vulnerability-report.yml new file mode 100644 index 00000000..d07737d5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-vulnerability-report.yml @@ -0,0 +1,48 @@ +name: Vulnerability Report +description: Report a potential software vulnerability +title: "[Vulnerability]: " +body: + - type: textarea + id: summary + attributes: + label: General Summary + description: Please provide a general summary of the problem + placeholder: e.g. "An unsafe deserialization vulnerability allows any unauthenticated user to execute arbitrary code on the server." + validations: + required: true + - type: textarea + id: component + attributes: + label: Effected Component(s) + description: List the components effected by this vulnerability + validations: + required: true + - type: textarea + id: impact + attributes: + label: Impact of Vulnerability + description: Describe the scope of the vulnerability's impact + validations: + required: true + - type: textarea + id: remediation + attributes: + label: Possible Remediation + description: Propose a remediation suggestion if you have one. + validations: + required: false + - type: textarea + id: reproduce + attributes: + label: Steps to Reproduce + description: Explain how to reproduce the problem + placeholder: e.g. "1. The first step to reproduce this error is to access the members area..." + validations: + required: true + - type: textarea + id: description + attributes: + label: Detailed Description + description: Please provide a more detailed description + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..0086358d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..804a788c --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,24 @@ +### General Summary + +### Description + + +### Related Issue + + +--- + +### Motivation and Context + +### How Has This Been Tested? + + + +### Screenshots (if appropriate): + +--- + + +- [ ] The commit message follows guidelines +- [ ] Tests for the changes have been added +- [ ] Documentation has been added/ updated diff --git a/docs/GIT_FLOW.md b/docs/GIT_FLOW.md index 385db7e6..44bf7eb3 100644 --- a/docs/GIT_FLOW.md +++ b/docs/GIT_FLOW.md @@ -42,104 +42,3 @@ Please see **[Semantic Versioning](https://semver.org/)** **SemVer** -> fix type commits should be translated to PATCH releases. feat type commits should be translated to MINOR releases. Commits with BREAKING CHANGE in the commits, regardless of type, should be translated to MAJOR releases. See more: [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#specification) - -## Issues Templates: - -### Bug report - -``` -## General Summary - -## Expected Behavior - -## Current Behavior - -## Possible Solution - - -## Steps to Reproduce - -1. -2. -3. -4. - -## Context (Environment) - -## Detailed Description - -## Possible Implementation -``` - -### Feature request - -``` -## Suggested Change - - -## Is This Breaking? - - -## Current Behavior - -## New Behavior - -## Detailed Description - -``` - -### Vulnerability report - -``` -# Vulnerability Report - -I identified potential security vulnerabilities in [Component]. - -## Summary - - -## Component - -## Impact - -## Remediation - - -## Steps to Reproduce - -1. -2. -3. -4. - -## Detailed Description - - -``` - -## PR Template -``` - -- [ ] The commit message follows guidelines -- [ ] Tests for the changes have been added -- [ ] Documentation has been added/ updated - -## General Summary - -## Description - - -## Related Issue - - -## Motivation and Context - -## How Has This Been Tested? - - - -## Screenshots (if appropriate): -``` - -For reference: *[Using templates](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository)* -