Wiki: Project Profile Issue Template

[JessicaLucindaCheng]

Overview

We need a wiki page that explains how to make a developer issue out of a Project Profile Change Request Issue created by Stakeholder so that when these requests come in, it's easy for anyone on the merge team to turn it into an actionable issue, without prior knowledge of how those issues get built.

Action Items

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

Resources/Instructions

REPLACE THIS TEXT -If there is a website which has documentation that helps with this issue provide the link(s) here.

Jessica's notes

• Please leave the "Complexity: Missing" and "size: missing" labels for now.
• This is currently still a work in progress.
• The purpose of this is
  • to have a template that can be used to easily write issues from "Update Project Profile" requests
  • to test out a possible format for the Project Profile Template in the wiki, where each comment below will represent a page in the wiki
• The content in this may eventually get moved elsewhere.

[JessicaLucindaCheng]

Project Profile Issue Template

This wiki contains templates and examples for helping to write an issue to update a project's profile.

Instructions

Please read our How to create issues wiki page, if you haven't already.

Copy and paste the templates from below. Notice any instructions in brackets [ ] and replace the instructions (including the brackets) as instructed. For example, by following the instructions in Update Project Profile: [Insert project's name] ([Insert short description of change]), the result can be Update Project Profile: Lucky Parking (Add Danny Pham).

Table of Contents

1. Add a title to the issue
2. Add the basic issue format(Wiki: Project Profile Issue Template #5630 (comment))
3. Based on the requested changes, add the relevant action items from below
   3.1. Update project title(Wiki: Project Profile Issue Template #5630 (comment))
   3.2. Update the description
   3.3. Update the image
   ---> Add Update image hero here
   3.4. Update the technologies
   3.5. Update the partner(s)
   3.6. Update the tools
   3.7. Update the GitHub link
   3.8. Update the Slack link
   3.9. Update the Test Site link
   3.10. Update Demo Site link
   3.11. Update Site link
   3.12. Leadership
   3.12.1. Remove person(s) and info from leadership
   3.12.2. Add person(s) and info to leadership
   3.13. Change project status
4. Add labels
5. Submit new issue
6. Check the issue is added to the "Project Board (hackforla/website)"

1. Add a title to the issue

Template

Update Project Profile: [Insert project's name] ([Insert short description of change])

Example

• Update Project Profile: Lucky Parking (Add Danny Pham) #5792

Return to Table of Contents

2. Add the basic issue format

Template

### Prerequisites
1. Be a member of Hack for LA. (There are no fees to join.) If you have not joined yet, please follow the steps on our [Getting Started](https://www.hackforla.org/getting-started) page and attend an onboarding session.
2. You have already read our [How to Contribute to Hack for LA Guide](https://github.com/hackforla/website/blob/gh-pages/CONTRIBUTING.md).

### Overview
We need to keep project information up to date so that visitors to the website can find accurate information.

### Action Items
- [ ] In your IDE, open the `_projects/[Insert filename].md` file.
- [ ] Observe the existing syntax of the front matter block [^1] in the file.
- [ ] [Insert relevant action items. See the rest of the guide for action items to add here.]
- [ ] Verify the changes by viewing the following in your local environment and include before and after screenshots with your pull request:
  - [ ] [Insert name of project] page [^2]
  - [ ] the project's card on the Projects' page [^3]   [If the ONLY changes are for the `leadership` variable, REMOVE this action item to check the project's card.]
- [ ] Once your pull request is merged, go to #[Insert ER number that initiated this issue] and
  - [ ] Check off this issue under the _Dependency_ section
  - [ ] If all the issues in the _Dependency_ section are checked off, move #[Insert ER number that initiated this issue] to **Questions / In Review** column and uncheck the **Dependency label**.
    - <details>
        <summary>Click here to see how to uncheck the <b>Dependency label</b></summary>
        <img src="https://github.com/hackforla/website/assets/31293603/6f53f4d4-7d2c-45f8-8534-9936fc9adee8" width="300px">
      </details>

### Resources/Instructions
- This issue was initiated by #[Insert ER number]
[^1]: [Info about the front matter block](https://jekyllrb.com/docs/front-matter/)
[^2]: Project detailed info page URL: [Insert project-specific page URL here]
[^3]: Projects page URL: https://www.hackforla.org/projects/ [If the ONLY changes are for the `leadership` variable, REMOVE this resource to the Projects page.]

Example for Leadership Only Changes

• Update Project Profile: Hack for LA Site (Remove Anjola Jaiyeola, Add Kelly Chuang) #6632

Example for All Other Changes

• Update Project Profile: Lucky Parking (Update Technologies) #5790

Return to Table of Contents

[JessicaLucindaCheng]

3.1. Update project title

Template

- [  ] Find the `title` variable and change the following:

**From:**
```
[Insert current line(s) of code for title]
```
**To:**
```
[Insert desired code changes to title]
```

Example

• [PENDING] When there is a title change for a project, add that issue as an example here

Back to Table of Contents

[JessicaLucindaCheng]

3.2. Update the description

Template

- [  ] Find the `description` variable and change the following:

**From:**
```
[Insert current line(s) of code for description]
```
**To:**
```
[Insert desired code changes to description]
```

Example

• [PENDING] When there is a description change for a project, add that issue as an example here

Back to Table of Contents

[JessicaLucindaCheng]

3.3. Update the image (WIP)

Template

- [  ] Find the `description` variable and change the following:

**From:**
```
[Insert current line(s) of code for description]
```
**To:**
```
[Insert desired code changes to description]
```

Example

• [PENDING] When there is an image change for a project, add a link to that issue as an example here.

Back to Table of Contents

[JessicaLucindaCheng]

3.4. Update the technologies

Template

- [ ] Find the `technologies` variable and change the following:

**From:**
```
[Insert current lines of code for technologies]
```
**To:**
```
[Insert desired code changes to technologies]
```

Example

• Update Project Profile: 311 Data (Update Technologies, Add Ahmed Awadalla & Edwin Jue) #5854

Back to Table of Contents

[JessicaLucindaCheng]

3.5. Update the partner(s)

Template

- [ ] Find the `partner` variable and change the following:

**From:**
```
[Insert current line of code for partner]
```
**To:**
```
[Insert desired code changes to partner]
```

Example

• Find the partner variable and change the following:

From:

partner: Department of Neighborhood Empowerment

To:

partner: Department of Neighborhood Empowerment, Atwater Village

Back to Table of Contents

[JessicaLucindaCheng]

3.6. Update the tools

Template

- [ ] Find the `tools` variable and change the following:

**From:**
```
[Insert current lines of code for tools]
```
**To:**
```
[Insert desired code changes to tools]
```

Example

• Find the tools variable and change the following:

From:

tools:
  - Google Colab

To:

tools:
  - pnpm
  - GitHub
  - Storybook
  - Google Colab

Back to Table of Contents

[JessicaLucindaCheng]

3.7. Update the GitHub link

Template

- [  ] Under the `links` variable, find `name: GitHub` and change the following:

**From:**
```
  - name: GitHub
    url: `[Insert current URL]`
```
**To:**
```
  - name: GitHub
    url: `[Insert desired URL]`
```

Example

• [PENDING] When there is a GitHub link change for a project, add that issue as an example here

Back to Table of Contents

[JessicaLucindaCheng]

3.8. Update the Slack link

Template

- [  ] Under the `links` variable, find `name: Slack` and change the following:

**From:**
```
  - name: Slack
    url: `[Insert current URL]`
```
**To:**
```
  - name: Slack
    url: `[Insert desired URL]`
```

Example

• [PENDING] When there is a Slack link change for a project, add that issue as an example here

Back to Table of Contents

[JessicaLucindaCheng]

3.9. Update the Test Site link

Template

- [  ] Under the `links` variable, find `name: Test Site` and change the following:

**From:**
```
  - name: Test Site
    url: `[Insert current URL]`
```
**To:**
```
  - name: Test Site
    url: `[Insert desired URL]`
```

Example

• [PENDING] When there is a Test Site link change for a project, add that issue as an example here

Back to Table of Contents

[JessicaLucindaCheng]

3.10. Update Demo Site link

Template

- [  ] Under the `links` variable, find `name: Demo Site` and change the following:

**From:**
```
  - name: Demo Site
    url: `[Insert current URL]`
```
**To:**
```
  - name: Demo Site
    url: `[Insert desired URL]`
```

Example

• [PENDING] When there is a Demo Site link change for a project, add that issue as an example here

Back to Table of Contents

[JessicaLucindaCheng]

3.11. Update Site link

Template

- [  ] Under the `links` variable, find `name: Site` and change the following:

**From:**
```
  - name: Site
    url: `[Insert current URL]`
```
**To:**
```
  - name: Site
    url: `[Insert desired URL]`
```

Example

• [PENDING] When there is a Site link change for a project, add that issue as an example here

Back to Table of Contents

[JessicaLucindaCheng]

3.12. Leadership

3.12.1. Remove person(s) and info from leadership

Template

- [ ] Find the `leadership` variable and remove the following:
```
[Insert the lines of code to remove the specified leadership member]
```

Example

• Update Project Profile: Hack for LA Site (Remove Anjola Jaiyeola, Add Kelly Chuang) #6632

3.12.2. Add person(s) and info to leadership

Template

- [ ] Find the `leadership` variable and add the following profile. If there are other [Insert role]s, place [Insert leadership member's name]'s profile after the other [Insert role]s' profiles.
```
  - name: [Insert leadership member's name]
    github-handle: [Insert GitHub handle]
    role: [Insert role]
    links:
      slack: https://hackforla.slack.com/team/[Insert Slack member ID]
      github: https://github.com/[Insert GitHub handle]
    picture: https://avatars.githubusercontent.com/[Insert GitHub handle]
```

Example

• Update Project Profile: Hack for LA Site (Remove Anjola Jaiyeola, Add Kelly Chuang) #6632

Back to Table of Contents

[JessicaLucindaCheng]

3.13. Change project status

Template

- [ ] Find the `status` variable and change the status

**From**
```
status: [Insert current status]
```
**To**
```
status: [Insert desired status]
```

Example

• Update Project Profile: Access the Data (Change Status to On Hold, Remove AJ Price & Jason Yung) #6064

Back to Table of Contents

[JessicaLucindaCheng]

4. Add labels

Apply the following:

• A complexity label
  • Either a good first issue label or Complexity: Small label
• Feature label(s)
  • P-Feature: Project Info and Page
  • If changes affect the Project page, add the P-Feature: Projects page
• role: front end and role: back end/devOps
• size: 0.25 pt
• time sensitive

Back to Table of Contents

[JessicaLucindaCheng]

5. Submit new issue

Select the Submit new issue button.

Back to Table of Contents

[JessicaLucindaCheng]

6. Check the issue is added to the "Project Board"

Check the new issue you just created is on the "Project Board".

If the issue is not on the "Project Board", add it to the "Project Board".

Back to Table of Contents

[ExperimentsInHonesty]

@JessicaLucindaCheng I have temporarily added the label: Ignore: Test so that this does not show up in the dashboard. When you are done crafting it, please remove the label.

[ExperimentsInHonesty]

@JessicaLucindaCheng I used the templates in this issue to create a draft issue and found that it was good for changing things that are already there, but not so good for changing things that don't exist in the .md file. See my issue draft for examples
#6579 (comment)

[JessicaLucindaCheng]

Update

• Progress: Need to finish the initial draft for changing things in project profiles.
• Blockers: None
• Availability: TBA
• ETA: TBA

Tasks

• Figure out if a template like this should be added somewhere in here or separately: Update Project Profile: Access the Data #5337
• Figure out what items need to be modified to include adding it if it doesn't exist. See:
  • ER: Update Project Profile: Expunge Assist #6579 (comment)
  • Wiki: Project Profile Issue Template #5630 (comment)

[JessicaLucindaCheng]

3. Based on the requested changes, add the relevant action items from below
   3.1. Update project title - will exist
   3.2. Update the description - will exist
   3.3. Update the image - will exist
   3.4. Update the technologies
   3.5. Update the partner(s)
   3.6. Update the tools
   3.7. Update the GitHub link - will exist
   3.8. Update the Slack link - will exist
   3.9. Update the Test Site link
   3.10. Update Demo Site link
   3.11. Update Site link
   3.12. Leadership - will exist
   3.12.1. Remove person(s) and info from leadership
   3.12.2. Add person(s) and info to leadership
   3.13. Change project status - will exist
4. Add labels
5. Submit new issue
6. Check the issue is added to the "Project Board (hackforla/website)"

• add project one sheet for stakeholder to fill out in template that they use for project updates
• add how to add and edit a one sheet in here
• see existing templates and update my template as necessary:
  • https://github.com/hackforla/website/issues/7512
  • https://github.com/hackforla/website/issues/new/choose
    • Project Profile leader updates - Add
    • Project Profile leader updates - Remove