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

TWE: Create Template Issue: Create Research Roadmap Timeline Template #370

Open
23 tasks
pandanista opened this issue Feb 20, 2023 · 3 comments
Open
23 tasks

Comments

@pandanista
Copy link
Member

pandanista commented Feb 20, 2023

Dependency

Overview

We need to create a template issue for research roadmap timeline so that we have consistent, transparent, defined and self-supporting structure for people creating them.

Action Items

  • Add to the Project Board
  • 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.
  • Any place you see [replace...] replace both the text and the brackets with what it is asking for
  • Create a draft of new template by copying the content block below to a comment on this issue, which will be known as our Draft
  • In your draft, Fill out the top part (called front matter) with the info it needs. See the Resources section below for definition and example.
  • 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
  • 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: [replace with name of type]]
  • 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 for creating new issue using the ["REPLACE with name and link of template"] template on the "New issue" tab

WIKI Templates

Content to copy for draft

Draft of [replace with name of type] template issue
---
name: TWE: Create Template Issue: [replace with name of template]
about: 
title: TWE: [replace with action verb] [replace with name of 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
- [ ] Find WIKI page for this issue by looking at role pages [Internship Wiki, Join the team page](https://github.com/hackforla/internship/wiki/Joining-the-Team) - then add the appropriate link to the resources section
- [ ] Find document template that should be used [Templates & Product Branding](https://github.com/hackforla/internship/wiki/Design-Process-Overview) - 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 (including in the front matter above but not where it says name, but not where it says title.
- [ ] add appropriate labels and remove the corresponding missing labels
- [ ] 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 DO X FOR Y 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

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)
  • 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: ''
@priyatalwar
Copy link
Member

@pandanista this issue is in the new issue approval. Are you still currently working on it? If so, please move it to "in progress". Thanks!

@pandanista
Copy link
Member Author

pandanista commented Jun 13, 2023

@priyatalwar I am moving this one to icebox for now since there is no urgent need for the team to draft and test this template at the moment.

@priyatalwar
Copy link
Member

Sounds good. Thanks!

@priyatalwar I am moving this one to icebox for now since there is no urgent need for the team to draft and test this template at the moment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Ice Box
Development

No branches or pull requests

3 participants