Skip to content

add note to README about assigning labels for new issues #409

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.

Sign up for GitHub

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

Open
nickvisut wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add note to README about assigning labels for new issues #409

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@ Useful resources:
- [Notion wiki](https://www.notion.so/sfbrigade/Compass-source-of-truth-db118a6d51344dccadc49d1988662d66)
- [Slack channel](https://sfbrigade.slack.com/archives/C01R8E75N1K)

## Filing a new issue

If you run into an issue or would like to request a feature, please file an issue.
Copy link
Copy Markdown
Contributor

@mrabbitt mrabbitt Sep 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For an issue that requests a new feature, it may require both UX design work and engineering work. What label(s) are appropriate in that situation?

Copy link
Copy Markdown
Contributor Author

@nickvisut nickvisut Sep 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it sounds like we may no longer need these labels. if so, we could get rid of them and the prefixes (at least moving forward)

@tam-janice, given the new board structure, will we no longer have separate eng and dev tickets? asking b/c traditionally the tickets were either prefixed with [ENG] or [UX] (or alternatively assigned similar labels).

Copy link
Copy Markdown
Contributor Author

@nickvisut nickvisut Sep 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we could also repurpose the labels for "engineering"-only (tech stuff, chores) and "UX"-only tickets (design that isn't meant to be handed off to dev), which would distinguish them from a story/task that goes through the whole lifecycle.

Copy link
Copy Markdown

@tam-janice tam-janice Sep 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's what I'm thinking:

  • We remove the prefixes [eng] and [UX]
  • We will keep the column 'in design'
  • If something needs design, it'll jsut be assigned to me and I'll take care of it
  • there will never be a ticket that reqires both UX and eng. If it's an eng ticket design should already be done

Does this work?


When creating an issue, please assign the following issue labels where appropriate:

- "design" label for a design or UX issue
- "engineering" label for an engineering issue

## Contributing to our code base

### One time setup
Expand Down