backend icon indicating copy to clipboard operation
backend copied to clipboard

[Documentation] Set up GitHub Issue Templates

Open aonomike opened this issue 5 years ago • 14 comments

Set up TEMPLATE.md files to guide contributors creating new issues on the standard of the detail to include on their issues. Something more like this

aonomike avatar Mar 29 '20 01:03 aonomike

FWIW, the minimum I'd like to see in an issue template, personally, are:

Context

Acceptance Criteria

[ ] Example task 1 [ ] Example task 2

Other implementation notes (to help the contributor who makes the PR)

lpatmo avatar Mar 29 '20 22:03 lpatmo

@lpatmo - assigned the two of us, since we've been going back and forth on the PR templates, and you mentioned you wanted to look at issue templates as well. Happy to take a first shot at this, or you can. 😄

BethanyG avatar Aug 23 '20 21:08 BethanyG

Just going to put this here as a possibility. You can have multiple issue templates:

image

BethanyG avatar Aug 25 '20 09:08 BethanyG

Proposal for the types of issues we can have:

  • Ask a question (linking to a new discussion under the question category)
  • Bug
  • Feature
  • Refactor
  • Documentation
  • Other

(kind of paralleling what we have in the PR template)

... and TBD on the content that should go in each of them :D

lpatmo avatar Aug 26 '20 02:08 lpatmo

That looks great!

I wonder if we also want Start a discussion? I go back and forth. On one hand, we're socializing the discussions pretty hard right now in the community. On the other - if someone has a proposal that they want to discuss - do we want them opening bug or feature issue about it (with maintainers moving things to discussion as needed) - or do we want to prompt contributors to do it the other way around? Either works. Really don't have a strong opinion there.

Other "categories" that come to mind are:

  1. Tooling -- or is that generally covered under "other"?
  2. Tests Needed - or is that just asking for trouble?

BethanyG avatar Aug 26 '20 18:08 BethanyG

..with automation, we can also put appropriate tags on the templates, as well as putting them into a "triage" area in a project, assigning a team to review, etc. etc. Haven't read all of this - but here is the GitHub documentation

Here, also for ease of access is the current documentation for multiple issue templates in GitHub

BethanyG avatar Aug 26 '20 19:08 BethanyG

Updated proposal (merging in your suggestions for Tests Needed and Start a Discussion):

Ask a question (linking to a new discussion under the question category)
Bug
Feature
Refactor
Documentation
Tests Needed
Start a Discussion
Other

lpatmo avatar Aug 27 '20 02:08 lpatmo

Looks good! We can work on template drafts as we find time this week....or next! 😄

BethanyG avatar Aug 28 '20 04:08 BethanyG

Thanks! ... yeah, looking more like next week :)

lpatmo avatar Aug 30 '20 06:08 lpatmo

@lpatmo hate to "bump" this..but if we are going to work on it, now is probably a good time..before we get overrrun in Hackoberfest. 😄

BethanyG avatar Sep 25 '20 00:09 BethanyG

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Oct 25 '20 02:10 stale[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Nov 25 '20 18:11 stale[bot]

@lpatmo Is this something we still need/want to work on, or do we close this?

BethanyG avatar Nov 25 '20 18:11 BethanyG

Sorry, this is still on my list! (Will try to get to this after I finish taking notes on Bill's deployment findings)

lpatmo avatar Nov 25 '20 20:11 lpatmo