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: template for revising issue templates [name of template] #530

Open
6 of 8 tasks
ExperimentsInHonesty opened this issue Jan 11, 2024 · 0 comments
Open
6 of 8 tasks

Comments

@ExperimentsInHonesty
Copy link
Member

ExperimentsInHonesty commented Jan 11, 2024

Overview

We need to revise all the research templates so that they have the new format of the newest templates being created.

Details

New features of templates

  • section headers (with bullets instead of check boxes)
  • resources divided up into ones used to create the issue and ones created by doing the issue.
  • expanding instructions on how to do things.

Action Items

Resources/Instructions

Template

# 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
- [ ] delete this section when all the checkboxes above are complete (i.e., the issue assignee will never see this part)

### Overview
We need to update the [Replace with name of Template] issue template so it has the same formatting as the most recent templates we have made.

### Action Items
We need to create a template issue for a [Replace with name of Template], so that we can create a [Replace with name of Template], when we are ready and maintain consistency with the org (across projects) and the guides project.

### Action Items
- [ ] Copy the example from Resource 1.01
  - [ ] Paste into a comment below using details to make it collapsible
  - [ ] Use the following text for the summary
```
## Current draft of [Replace with Name of template] Issue Template
```
- [ ] Copy the example from Resource 1.01
  - [ ] Use the following text for the summary
```
## Revised [Replace with Name of Template] Issue Template from the Guides Team
```
  - [ ] Add bullet headers and divide work in to sections
     - example: 
        - If the current template has
        > - [ ] Go to the Google Drive, Research, 1. Research by Type, Folder
        >    - [ ] Create a new folder in the drive called [number. name of type]
        - The revised template should have this text and formatting
        > - Create new Google Drive Folder
        >    - [ ] Go to the Google Drive, Research, 1. Research by Type, Folder (Resource # 1.04)
        >    - [ ] Create a new folder in the drive called [number. name of type] (e.g., 1. Mentor, 2. Intern) 
        >    - [ ] update the link in the resources below (Resource # 2.02)
  - [ ] Separate the resources into two sections
     - ```
        #### Resources for creating this issue
        ```
     - ```
        #### Resources gathered during the completion of this issue
        ```
  - [ ] Make sure each resource is in order of how it appears in the instructions
  - [ ] Number the resources
     - [ ] Add the numbers to the action items
- [ ] re-review the whole thing, to make sure 
   - [ ] all the instructions make sense
   - [ ] all the links resolve
   - [ ] the work is listed in the most logical order
- [ ] review with UX lead and get sign-off
- [ ] ask UX lead or product to update issue template Resource 1.03

### Resources/Instructions
1.01 [TWE [Replace with name of Template] Issue Template, new issue]
1.02 [Issue templates in the code](https://github.com/hackforla/internship/tree/main/.github/ISSUE_TEMPLATE)
1.03 [[Replace with Name of Template] Issue Template, code]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Prioritized Backlog
Development

No branches or pull requests

1 participant