Skip to content

Commit

Permalink
Merge pull request #77 from GSA-TTS/jadudm/onboarding-offboarding
Browse files Browse the repository at this point in the history
Onboarding/offboarding improvements
  • Loading branch information
IsabelLaurenceau authored Jan 7, 2025
2 parents 4ae1aab + ca8345d commit 1742c0b
Show file tree
Hide file tree
Showing 11 changed files with 399 additions and 33 deletions.
6 changes: 6 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# This file is sensitive since rules below may be used for restricting who can
# make access control changes.
/.github/CODEOWNERS @GSA-TTS/searchgov-admins

# Changes to the following Terraform directory will impact access control in cloud.gov spaces. Any PR involving these files should get a review from someone in FAC-admins.
/terraform/dev/developers.tf @GSA-TTS/searchgov-admins
16 changes: 0 additions & 16 deletions .github/ISSUE_TEMPLATE/Makefile

This file was deleted.

27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/adr-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: ADR issue template
about: Starting point for architecture decision records
title: '[ADR] <title>'
labels: 'adr'
assignees: ''
---

## Areas of impact

- [ ] Compliance
- [ ] Content
- [ ] CX
- [ ] Design
- [ ] Engineering
- [ ] Policy
- [ ] Product
- [ ] Process
- [ ] UX

## Related documents/links

## Context

## Decision

## Consequences
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: Bug Report 🐞
description: Report a bug and help Search.gov improve.
title: "Search.gov - Bug: [YOUR TITLE]"
labels: ["bug"]
projects: ["GSA-TTS/60"]
body:
- type: textarea
id: problem
attributes:
label: Describe the bug
description: Add a clear and concise description of the bug. Let us know if it impacts major or minor functionality and if you have workaround.
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Steps to reproduce the bug
description: Describe how to reproduce this issue.
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error...
validations:
required: true
- type: textarea
id: expectation
attributes:
label: Expected Behavior
description: Add a clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Add screenshots to help provide context, if applicable.
validations:
required: false
- type: textarea
id: system
attributes:
label: System setup
description: Provide your system details. Be sure to include your device, operating system, and browser (with version).
placeholder: |
- Device:
- Operating system:
- Browser and version:
validations:
required: false
- type: textarea
id: context
attributes:
label: Additional context
description: Add any other context about the problem.
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: Please confirm the following
options:
- label:
I agree to abide by the [Digital.gov Community Guidelines](https://digital.gov/communities/community-guidelines/) and the [TTS Code of Conduct](https://handbook.tts.gsa.gov/code-of-conduct/). Respect your peers, use plain language, and be patient.
required: true
- label:
I checked the [current
issues](https://github.com/GSA-TTS/FAC/issues?q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+Bug%22) for
duplicate bug reports.
required: true
40 changes: 37 additions & 3 deletions .github/ISSUE_TEMPLATE/epic.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,9 @@ assignees: ''
[comment]: # "How did this problem originate? If it was revealed through user feedback, how was that feedback received and from whom?"

## Job Story(s)

When I [situation], I want to [motivation] so I can [outcome/benefit].

## What are we planning to do about it?

[comment]: # "What is the scope of the design and engineering work required for this project?"
[comment]: # "Along the way, this epic will be linked with issues and pull requests"

Expand All @@ -27,4 +25,40 @@ When I [situation], I want to [motivation] so I can [outcome/benefit].
[comment]: # "What items have been considered but may fall out of the scope of design and engineering work for this project?"

## How will we measure success?
[comment]: # "Are there a set of quantifiable metrics that we can surface once the work has been completed in order to determine how successful our solution was?"
[comment]: # "Are there a set of quantifiable metrics that we can surface once the work has been completed in order to determine how successful our solution was?"


# Security Considerations
[comment]: # "Our SSP says 'The team ensures security implications are considered as part of the agile requirements refinement process by including a section in the issue template used as a basis for new work.'"
[comment]: # "Please do not remove this section without care."
[comment]: # "Note any security concerns that might be implicated in the change. 'None' is OK, but we must be explicit here."

Required per [CM-4](https://nvd.nist.gov/800-53/Rev4/control/CM-4).



<hr>

<details>
<summary>Process checklist</summary>

- [ ] Has a clear story statement
- [ ] Can reasonably be done in a few days (otherwise, split this up!)
- [ ] Shepherds have been identified
- [ ] UX youexes all the things
- [ ] Design designs all the things
- [ ] Engineering engineers all the things
- [ ] Meets acceptance criteria
- [ ] Meets [QASP conditions](https://derisking-guide.18f.gov/qasp/)
- [ ] Presented in a review
- [ ] Includes screenshots or references to artifacts
- [ ] Tagged with the sprint where it was finished
- [ ] Archived

### If there's UI...
- [ ] Screen reader - Listen to the experience with a screen reader extension, ensure the information presented in order
- [ ] Keyboard navigation - Run through acceptance criteria with keyboard tabs, ensure it works.
- [ ] Text scaling - Adjust viewport to 1280 pixels wide and zoom to 200%, ensure everything renders as expected. Document 400% zoom issues with USWDS if appropriate.


</details>
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Feature Request 💡
description:
Suggest a new idea for the design system.
title: 'Search.gov - Feature: [YOUR TITLE]'
labels: ['Type: Feature Request','Status: Triage']
body:
- type: markdown
attributes:
value: '## Feature Request 💡'
- type: textarea
id: problem
attributes:
label: Is your feature request related to a problem? Please describe.
description: "Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]"
validations:
required: true
- type: textarea
id: solution
attributes:
label: "Describe the solution you'd like"
description: "Provide a clear and concise description of what you want to happen."
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: "Describe alternatives you've considered"
description: "Provide a clear and concise description of any alternative solutions or features you've considered."
validations:
required: false
- type: textarea
id: context
attributes:
label: Additional context
description: "Add any other context or screenshots about the feature request."
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: Please confirm the following
options:
- label:
I agree to abide by the [Digital.gov Community Guidelines](https://digital.gov/communities/community-guidelines/) and the [TTS Code of Conduct](https://handbook.tts.gsa.gov/code-of-conduct/). Respect your peers, use plain language, and be patient.
required: true
- label:
I checked the [current
issues](https://github.com/GSA-TTS/FAC/issues?q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+Feature+Request%22) for
duplicate feature requests.
required: true
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/helpdesk-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
name: Helpdesk Issue
description: Used as output from helpdesk issue triage.
title: "[HD]: "
labels: ["helpdesk"]
projects: ["GSA-TTS/60"]
assignees:
- jadudm
body:
- type: markdown
attributes:
value: |
**Remember to keep all PII out of tickets.**

Do not use names, and do not attach files to this ticket.
- type: input
id: zendesk-link
attributes:
label: Zendesk link
description: Link to the issue in Zendesk
placeholder: ex. https://fac-something.zendesk.com/something/...
validations:
required: true
- type: checkboxes
id: fac-components
attributes:
label: Search.gov components involved
description: Select all that apply
options:
- label: crawling/indexing
- label: search results page
- label: API
- label: the helpdesk
- label: static site
- label: other
validations:
required: true
- type: dropdown
id: browser
attributes:
label: What browser did the user report as using?
multiple: false
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- Other (Opera, Brave, etc.)
- type: markdown
attributes:
value: |
Place all files and screenshots in the [Google Drive Helpdesk folder](https://drive.google.com/drive/folders/1L5eCVFlXxMyF98O2us5znZUPYaOx02gI) and link to that folder here.

- type: input
id: gdrive-link
attributes:
label: Gdrive link
description: Link to supporting files in GDrive
placeholder: ex. https://google.com/drive/something/...
validations:
required: false
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Summarize the issue the user is experiencing.
placeholder:
validations:
required: true
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/offboarding.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: : 🫂 Offboarding
about: An offboarding checklist for folks departing the team
title: Offboarding checklist for {GitHub Username}
labels: 'backlog'
assignees: ''
---

**Instructions for the issue creator:**
1. Fill in the GitHub username of the new person (if known) and the name of the onboarding buddy.
2. Remove the horizontal line below and everything above it (these instructions).
3. Remove sections that do not apply (based on role)

---

# We all serve, @{GitHub Username}, and thank you for yours

We serve the public through our work, and your work on Search.gov was most welcome. As you roll off the team, we still need to close some things out.

{OFFBOARDING BUDDY'S GH USERNAME} will be your offboarding buddy, and can help you if you get stuck on any of the steps in the checklist below. Accesses that need to be checked/removed:

- [ ] private team Slack channels
- [ ] Slack, if leaving TTS but staying within GSA
- [ ] team shared drive(s)
- [ ] team calendar
- [ ] ZD helpdesk instance
- [ ] FigJam (if appropriate)
- [ ] GH teams as appropriate:
- [ ] searchgov-admins
- [ ] searchgov-maintainers
- [ ] searchgov-team
- [ ] (Engineers) Remove yourself from Cloud.gov access, and create a PR. Add a comment below pointing to the PR below.
- [ ] Jira
- [ ] Confluence
- [ ] Trello

If you are leaving GSA employ, you will have other offboarding responsibilities beyond the scope of this ticket. This ticket tracks Search.gov accesses only.
Loading

0 comments on commit 1742c0b

Please sign in to comment.