From a5febf8d56a5c827b4252269614e82761258539d Mon Sep 17 00:00:00 2001 From: "Jason M. Gates" Date: Wed, 14 Feb 2024 15:37:57 -0700 Subject: [PATCH] chore: Switch GitLab to GitHub issue templates --- .github/ISSUE_TEMPLATE/bug.md | 34 ++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/discussion.md | 13 +++++++++ .github/ISSUE_TEMPLATE/documentation.md | 13 +++++++++ .github/ISSUE_TEMPLATE/feature.md | 16 +++++++++++ .github/ISSUE_TEMPLATE/post-mortem.md | 20 ++++++++++++++ .github/ISSUE_TEMPLATE/question.md | 19 +++++++++++++ .github/ISSUE_TEMPLATE/refactor.md | 12 +++++++++ .github/ISSUE_TEMPLATE/task.md | 19 +++++++++++++ .gitlab/issue_templates/Bug.md | 26 ------------------ .gitlab/issue_templates/Discussion.md | 10 ------- .gitlab/issue_templates/Documentation.md | 10 ------- .gitlab/issue_templates/Feature.md | 12 --------- .gitlab/issue_templates/Onboarding.md | 29 -------------------- .gitlab/issue_templates/Post-Mortem.md | 15 ----------- .gitlab/issue_templates/Question.md | 13 --------- .gitlab/issue_templates/Refactor.md | 10 ------- .gitlab/issue_templates/Security.md | 12 --------- .gitlab/issue_templates/Task.md | 13 --------- 18 files changed, 146 insertions(+), 150 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/discussion.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/feature.md create mode 100644 .github/ISSUE_TEMPLATE/post-mortem.md create mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/ISSUE_TEMPLATE/refactor.md create mode 100644 .github/ISSUE_TEMPLATE/task.md delete mode 100644 .gitlab/issue_templates/Bug.md delete mode 100644 .gitlab/issue_templates/Discussion.md delete mode 100644 .gitlab/issue_templates/Documentation.md delete mode 100644 .gitlab/issue_templates/Feature.md delete mode 100644 .gitlab/issue_templates/Onboarding.md delete mode 100644 .gitlab/issue_templates/Post-Mortem.md delete mode 100644 .gitlab/issue_templates/Question.md delete mode 100644 .gitlab/issue_templates/Refactor.md delete mode 100644 .gitlab/issue_templates/Security.md delete mode 100644 .gitlab/issue_templates/Task.md diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 0000000..ba55337 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,34 @@ +--- +name: Bug +about: What went wrong? +title: '' +labels: 'Type: Bug' +assignees: '' + +--- + +## Description +* What went wrong? +* What should have happened? +* Do you have an idea what might fix things? +* How has this bug affected you? +* What are you trying to accomplish? + +## Steps to Reproduce +1. Machine/OS: [insert here] +2. Python reproducer: + ```python + # Insert minimal example script here. + ``` +3. `stdout` from running the script: + ``` + # Paste stdout from the terminal here. + ``` +4. `stderr` from running the script: + ``` + # Paste stderr from the terminal here. + ``` +5. HTML log file: [attach here if applicable] + +## Screenshots +If applicable, add screenshots to help explain your problem. diff --git a/.github/ISSUE_TEMPLATE/discussion.md b/.github/ISSUE_TEMPLATE/discussion.md new file mode 100644 index 0000000..3d9aa6b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/discussion.md @@ -0,0 +1,13 @@ +--- +name: Discussion +about: What do we need to talk through? +title: '' +labels: 'Type: Discussion' +assignees: '' + +--- + +* What do we need to talk through? +* Why do we need to talk through it? +* What is needed for us to consider this discussion complete? +* Be sure to @mention whoever should be involved in the discussion. diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..39490c5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,13 @@ +--- +name: Documentation +about: What's wrong with the docs? +title: '' +labels: 'Type: Documentation' +assignees: '' + +--- + +* What would you like to see in the documentation? +* How does our current documentation not meet your needs? +* How has this lack of documentation affected you? +* What are you trying to accomplish? diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md new file mode 100644 index 0000000..1fba684 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -0,0 +1,16 @@ +--- +name: Feature +about: What new functionality is needed? +title: '' +labels: 'Type: Feature' +assignees: '' + +--- + +* What feature change/addition is needed? +* How does this differ from what we currently have? +* Do you have suggestions on implementation? +* What alternative solutions have you considered? +* How has the lack of this feature affected you? +* What are you trying to accomplish? +* What specifically must we demonstrate to call this work complete? diff --git a/.github/ISSUE_TEMPLATE/post-mortem.md b/.github/ISSUE_TEMPLATE/post-mortem.md new file mode 100644 index 0000000..f559d93 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/post-mortem.md @@ -0,0 +1,20 @@ +--- +name: Post-Mortem +about: Let's track down the root cause of a failure +title: '' +labels: 'Type: Post-Mortem' +assignees: '' + +--- + +## What Went Wrong? +Gather information and construct a detailed timeline of what contributed +to the problem. + +## Why Did It Go Wrong? +This is not for the purpose of blame, but to educate the team such that +we can learn from our mistakes. + +## Proposed Countermeasures +What changes can we implement to increase the likelihood that similar +problems will not happen in the future? diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..d929e82 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,19 @@ +--- +name: Question +about: What do you need to know? +title: '' +labels: 'Type: Question' +assignees: '' + +--- + +## Question +* What can we help you with? +* What is it you're trying to accomplish? +* Why do you need to do what you're trying to do? + +## Checklist +* [ ] Have you read through the [README](README.md)? +* [ ] Have you searched through [our documentation][docs]? + +[docs]: https://shell-logger.readthedocs.io diff --git a/.github/ISSUE_TEMPLATE/refactor.md b/.github/ISSUE_TEMPLATE/refactor.md new file mode 100644 index 0000000..7c209ca --- /dev/null +++ b/.github/ISSUE_TEMPLATE/refactor.md @@ -0,0 +1,12 @@ +--- +name: Refactor +about: What needs rework? +title: '' +labels: 'Type: Refactor' +assignees: '' + +--- + +* What needs to be cleaned up? +* How would the refactored implementation differ from what we have now? +* What are the potential downsides to not dealing with the technical debt now and leaving it for later? diff --git a/.github/ISSUE_TEMPLATE/task.md b/.github/ISSUE_TEMPLATE/task.md new file mode 100644 index 0000000..a605fcb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task.md @@ -0,0 +1,19 @@ +--- +name: Task +about: What needs to be done? +title: '' +labels: 'Type: Task' +assignees: '' + +--- + +## Description +* What needs to happen? +* Why does it need to happen? +* How does it relate to the rest of the project? +* What specifically must we demonstrate to call this work complete + +## Tasks +* [ ] First do this. +* [ ] Then do that. +* [ ] Also this other thing. diff --git a/.gitlab/issue_templates/Bug.md b/.gitlab/issue_templates/Bug.md deleted file mode 100644 index 8f26cf0..0000000 --- a/.gitlab/issue_templates/Bug.md +++ /dev/null @@ -1,26 +0,0 @@ -~"Type :: Bug" - -## Description - - - - - - -## Steps to Reproduce -1. Machine/OS: [insert here] -2. Python reproducer: - ```python - # Insert minimal example script here. - ``` -3. `stdout` from running script: - ``` - # Paste stdout from the terminal here. - ``` -4. `stderr` from running script: - ``` - # Paste stdout from the terminal here. - ``` -5. HTML log file: [attach here if applicable] - -/label ~"Type :: Bug" diff --git a/.gitlab/issue_templates/Discussion.md b/.gitlab/issue_templates/Discussion.md deleted file mode 100644 index e4aa01c..0000000 --- a/.gitlab/issue_templates/Discussion.md +++ /dev/null @@ -1,10 +0,0 @@ -~"Type :: Discussion" - - - - - - - - -/label ~"Type :: Discussion" diff --git a/.gitlab/issue_templates/Documentation.md b/.gitlab/issue_templates/Documentation.md deleted file mode 100644 index afe46bf..0000000 --- a/.gitlab/issue_templates/Documentation.md +++ /dev/null @@ -1,10 +0,0 @@ -~"Type :: Documentation" - - - - - - - - -/label ~"Type :: Documentation" diff --git a/.gitlab/issue_templates/Feature.md b/.gitlab/issue_templates/Feature.md deleted file mode 100644 index dabf01a..0000000 --- a/.gitlab/issue_templates/Feature.md +++ /dev/null @@ -1,12 +0,0 @@ -~"Type :: Feature" - - - - - - - - - - -/label ~"Type :: Feature" diff --git a/.gitlab/issue_templates/Onboarding.md b/.gitlab/issue_templates/Onboarding.md deleted file mode 100644 index 6dcea2a..0000000 --- a/.gitlab/issue_templates/Onboarding.md +++ /dev/null @@ -1,29 +0,0 @@ -~"Type :: Onboarding" - -This is the process to follow for integrating a new member into the development -team. - -# For the Mentor -* [ ] Have the new team member request a SRN GitLab account via - [Nile](https://nile.sandia.gov). -* [ ] Have them log in for the first time. -* [ ] Add them as a **Developer** to the [ShellLogger group - membership](https://internal.gitlab.server/groups/ShellLogger/-/group_members). -* [ ] Assign this issue to them. - -# For the New Team Member -* [ ] Move this issue into the ~"Stage :: Development" column on the [Kanban - board](https://internal.gitlab.server/ShellLogger/ShellLogger/-/boards). -* [ ] Read through the - [README](https://internal.gitlab.server/ShellLogger/ShellLogger/-/blob/master/README.md). -* [ ] Read through the [contributing - guidelines](https://internal.gitlab.server/ShellLogger/ShellLogger/-/blob/master/CONTRIBUTING.md). -* [ ] Read through [our - documentation](http://shelllogger.internal.gitlab.pages/ShellLogger/). -* [ ] Move this issue into ~"Stage :: Review". - -# For the Mentor -* [ ] Once you're satisfied the new team member is up to speed, close out this - issue. - -/label ~"Type :: Onboarding" diff --git a/.gitlab/issue_templates/Post-Mortem.md b/.gitlab/issue_templates/Post-Mortem.md deleted file mode 100644 index 1f54bf0..0000000 --- a/.gitlab/issue_templates/Post-Mortem.md +++ /dev/null @@ -1,15 +0,0 @@ -~"Type :: Post-Mortem" - -## What Went Wrong? - - - -## Why Did It Go Wrong? - - - -## Proposed Countermeasures - - - -/label ~"Type :: Post-Mortem" diff --git a/.gitlab/issue_templates/Question.md b/.gitlab/issue_templates/Question.md deleted file mode 100644 index 5982a2b..0000000 --- a/.gitlab/issue_templates/Question.md +++ /dev/null @@ -1,13 +0,0 @@ -~"Type :: Question" - -## Question - - - -## Checklist -* [ ] Have you read through the - [README](https://internal.gitlab.server/ShellLogger/ShellLogger/-/blob/master/README.md)? -* [ ] Have you searched through [our - documentation](http://shelllogger.internal.gitlab.pages/ShellLogger/)? - -/label ~"Type :: Question" diff --git a/.gitlab/issue_templates/Refactor.md b/.gitlab/issue_templates/Refactor.md deleted file mode 100644 index 1a66c7f..0000000 --- a/.gitlab/issue_templates/Refactor.md +++ /dev/null @@ -1,10 +0,0 @@ -~"Type :: Refactor" - - - - - - - - -/label ~"Type :: Refactor" diff --git a/.gitlab/issue_templates/Security.md b/.gitlab/issue_templates/Security.md deleted file mode 100644 index f088af1..0000000 --- a/.gitlab/issue_templates/Security.md +++ /dev/null @@ -1,12 +0,0 @@ -~"Type :: Security" - -## Description - - - -**Package version:** X.Y.Z - - - - -/label ~"Type :: Security" diff --git a/.gitlab/issue_templates/Task.md b/.gitlab/issue_templates/Task.md deleted file mode 100644 index a9d7241..0000000 --- a/.gitlab/issue_templates/Task.md +++ /dev/null @@ -1,13 +0,0 @@ -~"Type :: Task" - - - - -* [ ] First do this. -* [ ] Then do that. -* [ ] Also this other thing. - - - - -/label ~"Type :: Task"