Create a template structure for new issue templates

[ExperimentsInHonesty]

Instructions for creating this issue

The person who creates this issue should use these links to add links to the resources section and customize this issue

• Add the milestone: Project Management
• Add a feature label specific to what the template is related to, if available. If not clear what you should use, ask product.
• Find WIKI page for this issue by looking at role pages Internship Wiki, Join the team page - then add the appropriate link to the resources section
• If documents or folders (sheets, docs, presentations, dashboard, etc.) will be created, find the document template that should be used Templates & Product Branding - then add that specific template link into the resources section
• If no dependencies, delete dependency section
• Any place you see [replace...] replace both the text and the brackets with what it is asking for
• Delete this section when all the checkboxes above are complete (i.e., the issue assignee will never see this part)

Overview

We need to create a template for making new template issues, so that it's easy to create consistency and produce new template issues quickly

Action Items

• Add a draft of your template into the comment below
• review with user (in this case UX Research Lead)
• Update relevant WIKI page (See resources)

Resources/Instructions

• Find WIKI page for your role Internship Wiki, Join the team page
• place where we create and edit existing templates in this repo

Front Matter Fields and Meaning

• name: (name that appear on the new issue tab)
• about: (is the description that appears next to the issue template on the new issue tab
• title: (the title that appears when the issue is created. User then customizes this title for their issue)
• labels: (choose the labels that will be the same each time, and choose missing labels for the ones that depend on content)
• assignees:

Front Matter Field example

• name: 'Research: Roadmap'
• about: The start of a new roadmap
• title: 'TWE: Research Roadmap [name of type]'
• labels: 'feature: research, feature: roadmap, milestone: missing, role: UI/UX research,
• size: 0.50pt'
• assignees: ''

[ExperimentsInHonesty]

• I have reached out to Sarah on Slack at 2022-09-01 1:25pm to connect with her so she can try out the template.
• I added it as a template issue so that she could try it

[ExperimentsInHonesty]

• get update from Sara on TWE: Create Template Issue: Research Plan #313
  • added to agenda

[ExperimentsInHonesty]

Remaining Steps

• Since we made the last draft, we have added a numbering structure when you have an action item that is referring to a resource that will need to be used. A new draft will need to be made and then the draft of the current Create a new issue template issue template will need to be updated.
  

• A link to the template, once completed, should be made on the UX Research Guide Template page, Issue Template section with wording
  If you need a new Issue Template, please use the [Create a template issue] to create the draft.

[bradyse]

Draft version 2.0 as of 2022-11-14 (repo last commit 2022-11-02)

name: Create a template issue
about: This issue helps you structure your template issue to be consistent with our other template issues
title: 'TWE: Template Issue: [Replace NAME OF ISSUE TEMPLATE]'
labels: 'feature: board / google drive / tools, feature: missing, milestone: missing, role: missing, size: missing'
assignees: ''

---

Overview

We need to create a template issue for [Replace NAME OF ISSUE TEMPLATE] so that we have consistent, transparent, defined and self-supporting structure for people creating them.

Action Items

Customize this issue

• Customize this issue by adding the Name of Issue Template.
  • Note: An issue template's name is different from the issue title created from the template.
  • Search for [Replace NAME OF ISSUE TEMPLATE] by using the browser search (Mac: ⌘+F; PC: Ctrl+F)
  • Replace the keyword string (including text and the brackets) below with the name of your issue template according to the template naming convention: Type of Work: Direct object: Action verb
    • The type of work is the primary owner of the issue template (e.g., Research, Design, Marketing)
    • Direct object should be item that we're updating or working on (e.g., Wiki, Interviews, Roadmap)
    • Action verb should be the main descriptor of the action items (e.g., Update, Create, Transcribe)

Customize the issue settings (located in right sidebar)

Change the issue settings to ensure the issue is properly categorized and easy to manage.

• Under Assignees, assign yourself.
• Under Projects, click gear, choose "Repository," and choose Program Management.
• Add the milestone: Project Management
• Add a feature label specific to what the template is related to, if available. If not clear what you should use, ask product.

Customize template draft

Create a draft of new template, which will be known as our "draft".

• Copy the Content to copy for draft to a comment on this issue.
• In your draft, fill out the top part (called front matter) with the following information. See the Front Matter Resources section below for definitions and example.
  • Name
  • About
  • Title
  • Labels
• Define any Dependencies (or remove the dependency section)
• Customize the Overview section
• Fill out the Action Items section (in your draft) by defining the steps that are required to be done, keeping the following in mind:
  • The person working on this issue might be new to the org, so the issue should be able to be worked on without any prior knowledge
  • If the person needs to add links, or put documents in specific locations, the place where they can do that action must be linked in the resources section
    • the links provided by the issue creator should be in the same order as the Action Items
    • Refer to the Resource titled Example Action Items for Finding Wiki Page and Template for an example of how to write clear instructions that avoid compound steps (steps within a step).
  • Number each Resource in the order each resource appears in the Action Items
    • If there are a lot of Resources that could be organized as a set, group them into numbers and decimals (e.g., Resource 1.01, Resource 2.01)
    • Create Resource headings that collate all the 1s together and so on
• If documents or folders (sheets, docs, presentations, dashboard, etc.) will be created, find the document template that should be used by checking the WIKI Templates by role pages.
  • if there is a template
    • Add a link to the template into the ### Resources section of your draft
  • if there is no template yet
    • put a placeholder into the ### Resources section of the draft [TWE: Template Issue: [Replace NAME OF ISSUE TEMPLATE]]
• Get sign-off by product on the draft
• Create the template issue on the repo
• Add the link to related "Get started" button in the Resources section below.
• Update the appropriate place in wiki for your template (see resources section)

Resources/Instructions

Getting started button link

Getting started button link for creating new issue using the ["[Replace NAME OF ISSUE TEMPLATE]"]([Replace LINK]) template on the "New issue" tab

WIKI Templates

• by role pages
  • TWE: WIKI: UX Research Guides Templates
  • [Design]
  • [Product]
  • [Engineering]
• default document templates, in case you don't have one yet can found on the Design Process Overview page

Content to copy for draft

Draft of template issue for [Replace NAME OF ISSUE TEMPLATE]
---
**name:** Template Issue: [Replace NAME OF ISSUE TEMPLATE]
**about:** [Replace]
**title:** TWE: Template Issue: [Replace NAME OF ISSUE TEMPLATE]
**labels:** 'feature: board / google drive / tools', 'feature: missing', 'size: missing', 'role: missing', 'milestone: missing'
**assignees:** 

---
#### Instructions for creating this issue
The person who creates this issue should use these links to add links to the resources section and customize this issue
- Customize the issue keywords
    - [ ] Replace the keyword strings (including text and the brackets) below with the appropriate values by using the browser search (Mac: Command+F PC: Ctrl+F)
    - [ ] Search for `[Replace`
    - [ ] Replace with whatever the keyword or information is asking for.
- Customize the issue settings (located in right sidebar)
    - [ ] Under Labels, add labels for any labels identified as missing
    - [ ] Remove the corresponding missing labels
    - [ ] Under Projects, click gear, choose "Repository," and choose Program Management.
    - [ ] Add the milestone: [Replace MILESTONE]
    - [ ] Add a feature label specific to what the template is related to, if available. If not clear what you should use, ask product.
- Customize dependencies 
    - [ ] If no dependencies, delete dependency section
    - [ ] If dependencies, add the dependencies (any issue or reason that would prevent the action items from being completed)
- Remove this section.
    - [ ] Delete this section when all the checkboxes above are complete (i.e., the issue assignee will never see this part)

### Dependencies

### Overview
We need to [Replace ACTION] for [Replace REASON].

### Action Items
A STEP BY STEP LIST OF ALL THE TASK ITEMS THAT YOU CAN THINK OF NOW EXAMPLES INCLUDE: Research, reporting, etc.

### Resources
1.
2.

Front Matter Resources

Front Matter Fields and Meaning

• name: (name that appear on the new issue tab)
• about: (is the description that appears next to the issue template on the new issue tab
• title: (the title that appears when the issue is created. User then customizes this title for their issue)
  • Use the naming convention: TWE: Role: Direct object: Action verb
  • If more than one word should go into the direct object spot, use multiple square brackets with the keyword (see example)
• labels: (choose the labels that will be the same each time, and choose missing labels for the ones that depend on content)
• assignees:

Front Matter Field example

• name: 'Research: Roadmap'
• about: The start of a new roadmap
• title: 'TWE: Research: Roadmap [Replace TYPE OF PARTICIPANT]: Create'
• labels: 'feature: research, feature: roadmap, milestone: missing, role: UI/UX research,
• size: 0.50pt'
• assignees: ''

Example Action Items for Finding Wiki Page and Template

Example Action Items

### Action Items
- Customize wiki page
     - [ ] Go to link 1.01 Internship Wiki, Join the team page
     - [ ] Find wiki page for this issue by looking at role pages.
     - [ ] Copy the link for the wiki page.
     - [ ] Add the link to Resource 2.01
        - [ ] Add the name of the link in square brackets
        - [ ] Add the URL in parenthesis without a space between the square bracket and parenthesis
- Customize document template.
    - [ ] Go to link 1.02 Design Process Overview
    - [ ] Find document template that should be used in this issue.
    - [ ] Copy the link for the template.
    - [ ] Add the link to Resource 2.02
        - [ ] Add the name of the link in square brackets
        - [ ] Add the URL in parenthesis without a space between the square bracket and parenthesis

Example Resource Lists

### Resources for creating this issue
1.01. [Internship Wiki, Join the team page](https://github.com/hackforla/internship/wiki/Joining-the-Team)
1.02. [Design Process Overview](https://github.com/hackforla/internship/wiki/Design-Process-Overview)

### Resource links gathered during the making of this issue
2.01. [Wiki page for [Replace TYPE OF ROLE]]
2.02. [TWE: Template: [Replace NAME OF TEMPLATE]

[bradyse]

Sara's notes to herself about v. 2.0

• User didn't quite get right the name of the template issue. Need to explain better in instructions
• Need to modify pre-steps to include modifying list of relevant keywords to search for in order to customize resources.

[pandanista]

@AndrewSalvatore Would you please copy and paste the action item section you created for issue #429 to create a new folder on Google drive below so we can update the template? Thank you!

[ExperimentsInHonesty]

• I created an issue TWE: Update issue template: Research Roadmap #529 for updating an issue template that already exists (roadmap). I made this after the Guides Team copied the template in order to customize it for their own use, and found it to be helpful but inconsistent with the other TWE templates. Please review 529 and make sure the action items for the revision part are covered in the guidance for how to make a template issue.