Standardize on issue templates for the UX Guide and Methods
MelissaBraxton opened this issue · comments
Background
The adventures in co-working group is working on both the UX guide and the 18F Methods sites. Currently, the team uses a shared project board to manage this work. It can be frustrating to create new issues when the 2 repos do not have a shared default issue templates. Folks are manually filling a lot of issue info in which creates unnecessary work and inconsistencies. We want to settle on shared expectations re: what issue templates we need, and what constitutes a refined issue as ell as a way to make it easy to apply the templates when working on issues for either the UX Guide or the 18F Methods sites.
acceptance criteria
- We have agreed upon standard issue templates for what comprises (1) a basic issue, (2) an issue for onboarding a new contributor, (3) an issue for offboarding a contributor.
- Standard issue templates are easily accessible from either the 18F Methods or UX Guide repo
- Documented considerations for standard issue templates are easily accessible from either repo
tasks
- Co-design the three issue templates
- Determine where the templates will live
- Ensure that any READMEs and/or CONTRIBUTING guidance points to the appropriate issue templates
- Decide where issue template documentation will live
- Document considerations
Added myself mostly to keep track of this. We're doing similar documentation, but haven't looked at this yet at all—your work here may be logical to pull in centrally.
I've drafted three templates here. . Would love feedback!
@mgwalker - When you're back next week, I'd love to get your thoughts on how we can centralize the templates and make them easily available to both projects. (MVP is duplicating them in both repos, but that's... not ideal)
@MelissaBraxton I left some comments in the doc.
@mgwalker - I added the templates to both repos, but I think we'd talked about some kind of automation that would hhelp us keep them in sync? (Like, when you change one, you get some kind of notice "do you need to change this other one too?")
Does this sound familiar? Something you'd have a moment to walk me through setting up?
That is familiar, yes! It would require some custom automation code, though. It's not something that's built into GitHub, unfortunately. Want me to open a new issue for that?
Yes, that'd be great! Then we can bump it down in priority, and I can close this out. :high-five: