Design new ZenHub issue templates

[LexBirdie]

👇🏽 What is this issue about? Give as much detail as you can.

After receiving a tour of the ZenHub with an eye for onboarding and having a great conversation with Tam, I noticed that the current issue template in ZenHub doesn't quite serve the varied needs of the TEC working groups. The way ZenHub is currently used is especially confusing for newcomers trying to make their first contributions, and creating better clarity for that audience is what drew me to making this contribution.

Some issues only need the most basic of information, while others need greater detail. I want to create a small set of templates which better meet the different basic types of issues commonly created in the TEC ZenHub. My hope is to create better transparency for issues that call for the help of multiple members, and better flow for issues that are used like reminders-to-self; better enabling the distributed labor common in web3 and comprehension for newcomers through asynchronous communication.

My concept is to design new templates that could be chosen from the "Template" drop down list when creating a new issue or epic. The goal would be to create clear templates that are easy to use while inviting more in-depth thought and documentation of an issue where appropriate.

The four proposed templates are:

• Quick Issue - an easy and fast note-to-self style template
• Newbie Issue - a template for existing members to fill out when they want to create a "good first issue" which includes extra context for newcomers
• Contribution Issue - a template that balances the need for context without getting too bogged down -- great for contributions that make up epics, especially when help is wanted
• Epic Issue - a more in-depth template that both helps experienced members think through their primary goals, and provides clarity for newer members trying to understand the TEC's goals and roadmap

You can read more and find drafts of the issue templates in the link below. These drafts are currently being presented to the Communitas WG for rounds of review and feedback before being implemented, with easy avenues for additional feedback after implementation.

After getting these vetted and implemented, I'd like to create internal facing documentation to onboard existing members to these new templates -- as well as some "how to use ZenHub" documentation for newcomers learning to make their first contributions.

Next Steps:

• [x] Feedback on template concepts from Communitas WG
• [x] Create drafts for each template above
• [ ] Final feedback on finished template drafts from Communitas WG
• [ ] Create an internal-facing document which explains these new templates, their intended uses, and how to provide feedback.
• [ ] Create a feedback survey
• [ ] Implement templates in ZenHub – Repo Admin Support Required
• [ ] Communicate change to stewards/WGs – especially how to use “Newbie Template”
• [ ] Gather feedback from WG members, and newcomers trying to find their first contribution through quick survey linked in templates

Follow Up Project:

• [ ] Create “how to use ZenHub” and “how to make contributions” documentation for newcomers

✨ What does success look like? (i.e., the criteria to meet to call this issue done)

1. A fully fleshed out and vetted set of new templates are approved and added to the "Template" drop down section of the New Issue page.
2. TEC Working Group members have a more rewarding and efficient experience when creating issues in ZenHub, thinking through their projects, and answering fewer questions.
3. Well written issues receive the support they need.
4. Experienced and new members have an easier time choosing which issues they'd like to contribute to when looking through ZenHub.

🧍🏻‍♀️🧍🏻‍♂️ Who should be part of the Advice Process? (People who should be consulted about this issue. Those who will have valuable input.)

Communitas Working Group and those with an eye for onboarding or operations. Newcomers trying to make their first contribution to a working group. TEC working group members who use ZenHub to coordinate.

🔗 Are there links or docs related to this issue?

Issue Template Drafts: https://docs.google.com/document/d/1wXZ6jZfPrEECUMdDqypzL64MTB_HrX5Tyr4Vh4c4HiI/edit?usp=sharing

^^^ All feedback welcome in the comments of above google doc ^^^

👀 Who should be in the loop about this issue?

@eduardovegap @gideonro

Last updated - 7/12/22

[LexBirdie]

Follow up to this contribution would be to create a "how to navigate communitas zenhub" resource for newcomers and potentially make it a permanent readme "issue" in the zenhub. (suggested by @eduardovegap)

[LexBirdie]

Not able to add "Communitas WG" tag to this issue.

[tamarandom]

Hey LBS! This is very thoughtful. Like I mentioned on the Communitas call yesterday there is a lot of detail that is not necessary relevant to all issues but would be better suited for a project or even the epic template.

For Github, there was an unaccepted invitation to join this repo. I cancelled it and re-invited you to join this repo. You should receive an email... or notification in gtihub. Once you accept it you will be able to edit the tags and assignees.

[LexBirdie]

Some feedback from the June 20th Communitas meeting helped direct this issue a bit more. Now I'm angling to create a small variety of templates that can encompass the scope of work that is done in Communitas. Taking my first stab at this with my current knowledge. More concrete understanding about the operational structure for getting things done and how it plays out in the ZenHub would be helpful as I work on this.

[LexBirdie]

UPDATE: After feedback and clarification, I have a better sense of what this community may need from its ZenHub templates. The latest proposal is to create four new types of templates for the community to utilize as it sees fit.

• Quick Issue - like a "reminder to self"
• Epic Issue - high context on large WG goals
• Contribution Issue - medium context on smaller contributions that make up epics/projects
• Newbie Issue - self-contained contributions that are easy for newcomers to take on and have the extra info newcomers need

To learn more about these four proposed templates, see the google doc linked above.