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

[Documentation] Set up GitHub Issue Templates #119

Open
aonomike opened this issue Mar 29, 2020 · 14 comments
Open

[Documentation] Set up GitHub Issue Templates #119

aonomike opened this issue Mar 29, 2020 · 14 comments
Assignees
Labels
documentation Improvements or additions to documentation needs discussion The fix for this issue needs discussion P1 for MVP pinned

Comments

@aonomike
Copy link
Collaborator

aonomike commented Mar 29, 2020

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 aonomike added help wanted Extra attention is needed question Further information is requested labels Mar 29, 2020
@lpatmo
Copy link
Member

lpatmo commented Mar 29, 2020

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)

@BethanyG BethanyG changed the title [Tooling] Set up Issue Template [Documentation] Set up GitHub Issue Template Aug 16, 2020
@BethanyG BethanyG added the documentation Improvements or additions to documentation label Aug 16, 2020
@lpatmo lpatmo added the good first issue Good for newcomers label Aug 17, 2020
@BethanyG BethanyG removed the help wanted Extra attention is needed label Aug 20, 2020
@BethanyG BethanyG added P1 for MVP needs discussion The fix for this issue needs discussion and removed good first issue Good for newcomers question Further information is requested labels Aug 23, 2020
@BethanyG
Copy link
Member

@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
Copy link
Member

BethanyG commented Aug 25, 2020

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

image

@lpatmo
Copy link
Member

lpatmo commented Aug 26, 2020

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

@BethanyG
Copy link
Member

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 BethanyG changed the title [Documentation] Set up GitHub Issue Template [Documentation] Set up GitHub Issue Templates Aug 26, 2020
@BethanyG
Copy link
Member

BethanyG commented Aug 26, 2020

..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

@lpatmo
Copy link
Member

lpatmo commented Aug 27, 2020

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

@BethanyG
Copy link
Member

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

@lpatmo
Copy link
Member

lpatmo commented Aug 30, 2020

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

@BethanyG
Copy link
Member

@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. 😄

@stale
Copy link

stale bot commented Oct 25, 2020

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 stale bot added the stale label Oct 25, 2020
@BethanyG BethanyG removed the stale label Oct 26, 2020
@stale
Copy link

stale bot commented Nov 25, 2020

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 stale bot added the stale label Nov 25, 2020
@BethanyG
Copy link
Member

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

@lpatmo
Copy link
Member

lpatmo commented Nov 25, 2020

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

@stale stale bot removed the stale label Nov 25, 2020
@lpatmo lpatmo mentioned this issue Dec 15, 2020
13 tasks
@lpatmo lpatmo added the pinned label Jan 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation needs discussion The fix for this issue needs discussion P1 for MVP pinned
Projects
None yet
Development

No branches or pull requests

3 participants