Skip to content

Commit

Permalink
Merge pull request #2 from sandialabs/issue-templates
Browse files Browse the repository at this point in the history
chore: Switch GitLab to GitHub issue templates
  • Loading branch information
jmgate authored Feb 14, 2024
2 parents 76a00b5 + a5febf8 commit 7c64677
Show file tree
Hide file tree
Showing 18 changed files with 146 additions and 150 deletions.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -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.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/discussion.md
Original file line number Diff line number Diff line change
@@ -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.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -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?
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -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?
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/post-mortem.md
Original file line number Diff line number Diff line change
@@ -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?
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -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
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/refactor.md
Original file line number Diff line number Diff line change
@@ -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?
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/task.md
Original file line number Diff line number Diff line change
@@ -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.
26 changes: 0 additions & 26 deletions .gitlab/issue_templates/Bug.md

This file was deleted.

10 changes: 0 additions & 10 deletions .gitlab/issue_templates/Discussion.md

This file was deleted.

10 changes: 0 additions & 10 deletions .gitlab/issue_templates/Documentation.md

This file was deleted.

12 changes: 0 additions & 12 deletions .gitlab/issue_templates/Feature.md

This file was deleted.

29 changes: 0 additions & 29 deletions .gitlab/issue_templates/Onboarding.md

This file was deleted.

15 changes: 0 additions & 15 deletions .gitlab/issue_templates/Post-Mortem.md

This file was deleted.

13 changes: 0 additions & 13 deletions .gitlab/issue_templates/Question.md

This file was deleted.

10 changes: 0 additions & 10 deletions .gitlab/issue_templates/Refactor.md

This file was deleted.

12 changes: 0 additions & 12 deletions .gitlab/issue_templates/Security.md

This file was deleted.

13 changes: 0 additions & 13 deletions .gitlab/issue_templates/Task.md

This file was deleted.

0 comments on commit 7c64677

Please sign in to comment.