hackforla / internship

The Internship project provides an opportunity for students to work on open source projects in the fields of software, product development, project management, and UI/UX research and design at LA’s fastest growing Civic Tech non-profit organization during their summer.
GNU General Public License v2.0
14 stars 4 forks source link

[TEST] TWE: Create Template Issue: Create Consent Documents for Participants over 18 #551

Closed sunannie27 closed 2 days ago

sunannie27 commented 1 month ago

Overview

We need to create a template issue for creating TWE: Role: Consent Documents for Participants Over 18: Create (named in the format as TWE: Role: Direct Object: Action Verb) so that we have a consistent, transparent, defined, and self-supporting structure for people creating them.

Resources/Instructions: This section is at the bottom of this issue (scroll to the bottom to view it now). You will be asked to add links to this section while completing the issue.

Tip: Use two windows side by side. One with the issue open and the other one with resource links displayed to avoid back and forth. To prevent loss of work, refresh both windows after each edit.

Action Items

Customize this issue

Customize the issue settings (located in right sidebar)

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

Customize template draft

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

Resources/Instructions

Resources for creating this issue

1.01 Content to copy for draft

Draft of template issue for `TWE: Role: Consent Documents for Participants Over 18: Create`
---
**name:** TWE: Template Issue: Research: [Replace ACTION VERB][Replace DIRECT OBJECT]
**about:** We are creating a template to complete `TWE: Role: Consent Documents for Participants Over 18: Create` issue so we can stay consistent in our process
**title:** TWE: Research: IS[Replace YY]: RP[Replace 000]: [Replace TYPE OF PARTICIPANT] [Replace TYPE OF RESEARCH METHOD]: [Replace DIRECT OBJECT]: [Replace ACTION VERB]
**labels:** 'feature: research', 'feature: missing', 'size: missing', 'Participant Type: missing', 'Research 000: missing', 'role:  UI/UX research', 'milestone: missing', 'complexity: 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
    - [ ] 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, choose gear, choose "Repository," and choose TWE Project 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 VERB] [Replace DIRECT OBJECT] 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
#### Resources for creating this issue
1.01
1.02

#### Resources gathered during the completion of this issue
2.01
2.02

1.02 Front Matter Resources

1.02.01 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:
1.02.02 Front Matter Field example - name: 'TWE: Template Issue: Research: Create Roadmap' - about: We are creating a template to complete `TWE: Role: Consent Documents for Participants Over 18: Create` issue so we can stay consistent in our process - title: 'TWE: Research: IS[Replace YY]: RP[Replace 000]: [Replace TYPE OF PARTICIPANT] [Replace TYPE OF RESEARCH METHOD]: Roadmap : Create' - labels: 'feature: research', 'feature: roadmap', 'milestone: missing', 'role: UI/UX research', 'Participant Type: missing', 'Research 000: missing', 'complexity: missing' - 'size: 0.50pt' - assignees: ''

1.03 Example Action Items for Finding Wiki Page and Template

1.03.01 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 ```
1.03.02 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]] ```

1.04 WIKI Templates 1.04.01 by role pages

Resources gathered during the completion of this issue

2.01 ["Research: [Replace DIRECT OBJECT]: [Replace ACTION VERB]"]([Replace LINK])

sunannie27 commented 1 month ago

Draft of template issue for TWE: Role: Consent Documents for Participants Over 18: Create

name: TWE: Template Issue: Research: Creat Consent Documents for Participants Over 18 about: We are creating a template to complete TWE: Role: Consent Documents for Participants Over 18: Create issue so we can stay consistent in our process title: TWE: Research: IS[Replace YY]: RP[Replace 000]: [Replace TYPE OF PARTICIPANT] Consent Documents for Participants Over 18: Create labels: 'feature: research', 'feature: missing', 'size: missing', 'Participant Type: missing', 'Research 000: missing', 'role: UI/UX research', 'milestone: missing', 'complexity: missing' assignees: @sunannie27

Overview

We need to Create Consent Documents for Participants Over 18 for consistency.

Action Items

Resources for creating this issue

1.01 1.02

Resources gathered during the completion of this issue

2.01 2.02

pandanista commented 3 weeks ago

The name of Resources/Instructions could be confusing. Can we rename the section to Resources?

pandanista commented 3 weeks ago

Draft of template issue for Consent Documents Template for Participants over 18

name: TWE: Template Issue: Research: Create Consent Documents for Study Participants over the age of 18 about: This issue helps you structure your template issue to be consistent with our other template issues in consent documents title: TWE: IS[Replace YY]: RP[Replace 000]: [Replace TYPE OF PARTICIPANT] Informed Consent Documents (18 yrs +): Create labels: 'feature: research', 'Participant Type: missing', 'Research 000: missing', 'size: 1pt', 'role: UI/UX research', 'milestone: missing' assignees:


Instructions for creating this issue

Resources/Instructions: This section is at the bottom of this issue (scroll to the bottom to view it now). The person who creates this issue should use links in the section "Resources for creating this issue" (i.e., 1.01, 1.02, etc.) to customize this issue.

Tip: Use two windows side by side. One with the issue open and the other one with resource links displayed to avoid back and forth. To prevent loss of work, refresh both windows after each edit.

Overview

Create informed consent documents for RP[Replace 000] so that we can keep track of the participants who agree to participant in the study. This process only applies to participants over 18 years old.

Resources/Instructions: This section is at the bottom of this issue (scroll to the bottom to view it now). You will be asked to add links to this section while completing the issue.

Tip: Use two windows side by side. One with the issue open and the other one with resource links displayed to avoid back and forth. To prevent loss of work, refresh both windows after each edit.

Dependency:

Action Items

Customize Resource Links

Action Items for Distribution and Collection of Participants' Consent

Resources/Instructions

Resources for creating this issue

1.01 Wiki: Research Output Overview 1.02 Google Drive Folder: Research by Plan # and name 1.03 TWE: Template: Research Informed Consent Overview 1.04 TWE: Template: Research Informed Consent Form for Surveys/Interviews This consent form is for participants over 18 1.05 TWE: Template: Research Consent Email 1.06 1password 1.06.01 Guide: Log into a Google Account with 2-Step Verification Using 1Password If this is your first time logging into Internship's private drive, please follow the instructions to log in.

Resources gathered during the completion of this issue

2.01 [Wiki: Research Plan [Replace 000]] 2.02 [Google Drive Folder: RP[Replace 000]] 2.03 [[Replace TYPE OF PARTICIPANT] Research Plans and Goals] 2.04 [TWE: IS[Replace YY]: RP[Replace 000]: [Replace TYPE OF PARTICIPANT] Research Informed Consent Overview] 2.05 [TWE: IS[Replace YY]: RP[Replace 000]: [Replace TYPE OF PARTICIPANT] Research Informed Consent Form for Surveys/Interviews] This consent form is for participants over 18 2.06 [TWE: IS[Replace YY]: RP[Replace 000]: [Replace TYPE OF PARTICIPANT] Research Consent Email] 2.07 [TWE: IS[Replace YY]: RP[Replace 000]: [Replace TYPE OF PARTICIPANT] Research Informed Consent Form for Surveys/Interviews (Responses)] This consent form is for participants over 18

pandanista commented 3 weeks ago

This issue and #555 serve as a demo for template testing workflow.

The first comment is issue template.

The second comment is the template draft.

555 is the initial set up for template testing.

pandanista commented 2 weeks ago

Keep this issue open as a refrence for testing #555.

ExperimentsInHonesty commented 2 days ago

This issue is replaced by issues