Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update GitHub Issue templates #304

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,29 @@
---
name: 🐛 Bug report
about: Create a report to help us improve
about: Describe a bug, error, unexpected behavior, or other problem
---

# 🐛 Bug Report
# 🐛 Summary #

A clear and concise description of what the bug is.
What's wrong? Please be specific.

## To Reproduce
## To reproduce ##

Steps to reproduce the behavior:

- Do this
- Then this
1. Do this
1. Then this

## Expected behavior
## Expected behavior ##

A clear and concise description of what you expected to happen.
What did you expect to happen that didn't?

## Any helpful log output
## Any helpful log output or screenshots ##

Paste the results here:

```bash
```console

```

Add any screenshots of the problem here.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Submit an issue for the CyHy environment.
url: https://github.com/cisagov/cyhy-system/issues
about: Non-infrastructure issues should be made in the linked repository.
- name: 💬 Questions & Help
url: https://github.com/cisagov/.github/blob/develop/QUESTIONS.md
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might be a good place to link to this repo's Wiki instead of the generic page:

https://github.com/cisagov/cyhy_amis/wiki

Copy link
Member

@jsf9k jsf9k Jan 5, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unless you two have added useful content, that wiki does not hold a lot of value. Still, a project-specific link or content would make sense here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could add a link specifically to cisagov/cyhy-system, but I don't think there's much project-specific here to work with right now.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added an entry for the cisagov/cyhy-system Issues page in 948d24f to encourage issue creation for the CyHy environment to happen there instead. Please let me know any thoughts you all might have.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd change the wording to be directive, e.g.:

Create issues in the linked cyhy-system repository except for infrastructure issues with the AMIs, which should be created here.

about: If you have questions, visit GitHub Discussions and Wiki pages
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature.md

This file was deleted.

29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: 💡 Idea
about: Describe an idea, todo, feature, task, improvement, issue, epic, or story
---

# 💡 Summary #

What is the work, as a high-level summary?

## Motivation ##

Why does this work belong in this project?

This would be useful because...

## Implementation notes ##

Please provide details for implementation, such as:

- an example for how this would be used
- what this would look like
- how this would act
- any related work, including links to related issues

## Acceptance criteria ##

How do we know when this work is done?

- [ ] Criterion
14 changes: 0 additions & 14 deletions .github/ISSUE_TEMPLATE/question.md

This file was deleted.

33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/regression.md

This file was deleted.