Giters

stylelint / vscode-stylelint

The official Visual Studio Code extension for Stylelint

Home Page:https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Standardize labels

ybiquitous opened this issue · comments

commented

Currently, this repository's labels are quite different from other repositories' ones, for example, stylelint/stylelint.

GH_REPO=stylelint/vscode-stylelint gh label list -L 50 --json name --jq 'sort_by(.name).[].name'
49 labels in stylelint/vscode-stylelint 

Awaiting More Feedback
Blocked
Breaking Change
Bug
Committed
Declined
Dependencies
Design Limitation
Discussion
Docs
Duplicate
Effort: Casual
Effort: Difficult
Effort: Moderate
External
Fix Available
Fixed
For Backlog Issue
For Milestone Issue
For Uncommitted Issue
Good First Issue
Help Wanted
Housekeeping
Impact: Bad Fixes
Impact: Bad Lint Results
Impact: Fails to Run
In Discussion
Infrastructure
Investigating
Meta
Needs Documentation
Needs Investigation
Needs More Info
Needs Proposal
Needs Repro
Needs Revision
Needs Tests
Planning
Question
Ready to Implement
Refactor
Security
Suggestion
Tests
Unactionable
Upstream
Won't Fix
Work in Progress
Working as Intended


GH_REPO=stylelint/stylelint gh label list -L 50 --json name --jq 'sort_by(.name).[].name'
33 labels in stylelint/stylelint 

good first issue
help wanted
pr: blocked
pr: dependencies
priority: high
status: agreed but held
status: ask to implement
status: blocked
status: needs clarification
status: needs discussion
status: needs investigation
status: needs reproducible example
status: ready to implement
status: wip
syntax: css-in-js
syntax: html
syntax: less
syntax: markdown
syntax: postcss
syntax: sass
syntax: scss
type: bug
type: documentation
type: enhancement
type: infrastructure
type: new autofix
type: new option
type: new rule
type: refactor
type: security
type: tests
type: umbrella
upstream

I'm unsure why (historical reason?), but I think this is a good time to standardize the labels to reduce maintainers' confusion or work. Any thoughts?

References

commented

I am responsible for the quirky labels in this repo. There wasn't really a set standard at all years ago, so at the time I chose to base them off of the vscode repository. However, I agree that they would be better off being in alignment with the rest of the stylelint project. Consider this my +1 to standardize the labels.

commented

@adalinesimonian Thank you for getting back to me so quickly. I'll try mapping the current labels to the standard ones to prevent losing information.

commented

I've just created the mapping table. "N/A" is just my opinion for now. Please give me feedback if you find something strange. 🙏🏼

Current Standard Next Action Done?
Awaiting More Feedback N/A Remove (none) ✅
Blocked status: blocked Replace ✅
Breaking Change N/A Remove (only closed) ✅
Bug type: bug Replace ✅
Committed N/A Remove (none) ✅
Declined N/A Remove (only closed) ✅
Dependencies pr: dependencies Replace ✅
Design Limitation N/A Remove (only closed) ✅
Discussion status: needs discussion Replace ✅
Docs type: documentation Replace ✅
Duplicate N/A Remove (only closed) ✅
Effort: Casual N/A Rename to effort: casual (some opened) ✅
Effort: Difficult N/A Rename to effort: difficult (some opened) ✅
Effort: Moderate N/A Rename to effort: moderate (some opened) ✅
External N/A Remove (only closed) ✅
Fix Available N/A Remove (none) ✅
Fixed N/A Remove (only closed) ✅
For Backlog Issue N/A Remove (only closed) ✅
For Milestone Issue N/A Remove (only closed) ✅
For Uncommitted Issue N/A Remove (some opened but only dependency updates) ✅
Good First Issue good first issue Replace ✅
Help Wanted help wanted Replace ✅
Housekeeping N/A Remove (none) ✅
Impact: Bad Fixes N/A Remove (only one opened, but others closed) ✅
Impact: Bad Lint Results N/A Remove (only closed) ✅
Impact: Fails to Run N/A Remove (only closed) ✅
In Discussion status: needs discussion Replace ✅
Infrastructure type: infrastructure Replace ✅
Investigating N/A Remove (none) ✅
Meta N/A Remove (only one opened, but others closed) ✅
Needs Documentation N/A Remove (none) ✅
Needs Investigation status: needs investigation Replace ✅
Needs More Info status: needs clarification Replace ✅
Needs Proposal N/A Remove (none) ✅
Needs Repro status: needs reproducible example Replace ✅
Needs Revision N/A Remove (only one closed) ✅
Needs Tests N/A Remove (none) ✅
Planning N/A Remove (only closed) ✅
Question N/A Remove (only closed) ✅
Ready to Implement status: ready to implement Replace ✅
Refactor type: refactor Replace ✅
Security type: security Replace ✅
Suggestion type: enhancement Replace ✅
Tests type: tests Replace ✅
Unactionable N/A Remove (only closed) ✅
Upstream upstream Replace ✅
Won't Fix N/A Remove (only closed) ✅
Work in Progress status: wip Replace ✅
Working as Intended N/A Remove (only closed) ✅

N/A standard labels:

  • pr: blocked
  • priority: high
  • status: agreed but held
  • status: ask to implement

EDIT: Added next actions.
EDIT: Added "Done?" column

commented

For reference, I've put a few related links in this issue body.

commented

@jeddy3 Do you have any suggestions on this mapping? #491 (comment)

commented

@jeddy3 Do you have any suggestions on this mapping? #491 (comment)

Those mappings LGTM.

commented

Okay. I'm listing up next actions in #491 (comment)

commented

Listing up is done. I'm still considering how to address Effort: * labels. 🤔
Let me know if you have any thoughts.

commented

I'm not totally sure. They were very helpful for tagging issues with their effort and it made it much easier to both communicate to others what the scope of work on a ticket may be as well as knowing whether or not to commit to work. Personally, I think they're quite useful.

commented

Of course, we can leave this repository's specific labels, keeping consistency with the standard. For example, renaming Effort: Casual to effort: casual. Any thoughts?

commented

Good idea, why not? 🙂

commented

Okay, I've updated the next actions in #491 (comment). Please let me know if there is something weird. 🙏🏼

If nobody objects, let's do the manual work.

commented

No objections here.

commented

Okay, I've updated the next actions in #491 (comment).

All looks good to me, thank you!

commented

Thanks for the responses. I'll start the manual work from now.

EDIT: If you want to see the progress, please take a look at #491 (comment)

commented
Backup (JSON) 

[
  {
    "color": "7057ff",
    "description": "Well scoped, documented and has the green light",
    "name": "Good First Issue"
  },
  {
    "color": "6fa3db",
    "description": "You can do this",
    "name": "Help Wanted"
  },
  {
    "color": "e67cf4",
    "description": "A fix for this issue is blocked on another fix being in place",
    "name": "Blocked"
  },
  {
    "color": "ee0701",
    "description": "A bug in the extension",
    "name": "Bug"
  },
  {
    "color": "0366d6",
    "description": "Relates to dependencies",
    "name": "Dependencies"
  },
  {
    "color": "5319e7",
    "description": "The issue relates to how you familiarize yourself with the extension",
    "name": "Docs"
  },
  {
    "color": "e89595",
    "description": "Issue causes extension not to start or function at all",
    "name": "Impact: Fails to Run"
  },
  {
    "color": "556b75",
    "description": "Not yet reached consensus",
    "name": "In Discussion"
  },
  {
    "color": "fbca04",
    "description": "Issue relates to team infrastructure",
    "name": "Infrastructure"
  },
  {
    "color": "556b75",
    "description": "PR needs documentation to be added",
    "name": "Needs Documentation"
  },
  {
    "color": "dddddd",
    "description": "This issue needs a team member to investigate its status.",
    "name": "Needs Investigation"
  },
  {
    "color": "556b75",
    "description": "The issue still hasn't been fully clarified",
    "name": "Needs More Info"
  },
  {
    "color": "556b75",
    "description": "Issue needs reproduction details or a reproducible example",
    "name": "Needs Repro"
  },
  {
    "color": "556b75",
    "description": "PR needs changes to be made",
    "name": "Needs Revision"
  },
  {
    "color": "556b75",
    "description": "PR needs tests to be added",
    "name": "Needs Tests"
  },
  {
    "color": "008672",
    "description": "Issue is ready for someone to work on",
    "name": "Ready to Implement"
  },
  {
    "color": "C5EDF5",
    "description": "Improves the code structure",
    "name": "Refactor"
  },
  {
    "color": "006b75",
    "description": "An idea for the extension",
    "name": "Suggestion"
  },
  {
    "color": "F5C5EC",
    "description": "Relates to extension tests",
    "name": "Tests"
  },
  {
    "color": "28dfe2",
    "description": "Changes or fixes need to happen in an upstream package",
    "name": "Upstream"
  },
  {
    "color": "0e8a16",
    "description": "Someone is working on this issue",
    "name": "Work in Progress"
  },
  {
    "color": "B60205",
    "description": "Address or relates to a security vulnerability",
    "name": "Security"
  },
  {
    "color": "fac905",
    "description": "The severity and priority of this issue do not warrant the time or complexity needed to fix it",
    "name": "Won't Fix"
  },
  {
    "color": "fac905",
    "description": "The behaviour described is the intended behaviour; this is not a bug",
    "name": "Working as Intended"
  },
  {
    "color": "fac905",
    "description": "Constraints of the existing architecture prevent this from being fixed",
    "name": "Design Limitation"
  },
  {
    "color": "ef8854",
    "description": "Would introduce errors or break behaviour in existing installations",
    "name": "Breaking Change"
  },
  {
    "color": "cccccc",
    "description": "There isn't something we can do with this issue",
    "name": "Unactionable"
  },
  {
    "color": "80e580",
    "description": "A PR has been merged for this issue",
    "name": "Fixed"
  },
  {
    "color": "bee4be",
    "description": "A PR has been opened for this issue",
    "name": "Fix Available"
  },
  {
    "color": "ef8854",
    "description": "Relates to another program, environment, or user action which we cannot control.",
    "name": "External"
  },
  {
    "color": "4bddb3",
    "description": "Housekeeping PRs",
    "name": "Housekeeping"
  },
  {
    "color": "b4d9b6",
    "description": "Good issue if you're already used to contributing to the codebase. Harder than \"good first issue\".",
    "name": "Effort: Casual"
  },
  {
    "color": "67a8ed",
    "description": "Requires experience with the codebase, but feasible. Harder than \"Effort: Casual\".",
    "name": "Effort: Moderate"
  },
  {
    "color": "ee0701",
    "description": "Good luck.",
    "name": "Effort: Difficult"
  },
  {
    "color": "556b75",
    "description": "This issue needs a plan that clarifies the finer details of how it could be implemented.",
    "name": "Needs Proposal"
  },
  {
    "color": "556b75",
    "description": "Is in active investigation",
    "name": "Investigating"
  },
  {
    "color": "f9d0c4",
    "description": "Issue causes incorrect lint results",
    "name": "Impact: Bad Lint Results"
  },
  {
    "color": "009800",
    "description": "The team has roadmapped this issue",
    "name": "Committed"
  },
  {
    "color": "556677",
    "description": "The issue was declined as something which matches the extension's vision",
    "name": "Declined"
  },
  {
    "color": "556677",
    "description": "We'd like to hear from more people who would be helped by this feature",
    "name": "Awaiting More Feedback"
  },
  {
    "color": "f7c6c7",
    "description": "An existing issue was already created",
    "name": "Duplicate"
  },
  {
    "color": "5319e7",
    "description": "Issues which may not have code impact",
    "name": "Discussion"
  },
  {
    "color": "d4c5f9",
    "description": "An issue which isn't directly actionable in code",
    "name": "Question"
  },
  {
    "color": "d6c348",
    "description": "Issue causes incorrect fixes or formatting",
    "name": "Impact: Bad Fixes"
  },
  {
    "color": "bfdadc",
    "description": "An issue about the team or the extension's direction",
    "name": "Meta"
  },
  {
    "color": "4770b7",
    "description": "Iteration plans and roadmapping",
    "name": "Planning"
  },
  {
    "color": "9ff4ed",
    "description": "PRs that address a backlog bug or issue",
    "name": "For Backlog Issue"
  },
  {
    "color": "001f77",
    "description": "PRs that address a bug or issue with a specific milestone",
    "name": "For Milestone Issue"
  },
  {
    "color": "ededed",
    "description": "PR for untriaged, rejected, closed or missing bug or issue",
    "name": "For Uncommitted Issue"
  }
]

Via:

gh label list -R stylelint/vscode-stylelint --json name,description,color --limit 100
commented

All the tasks are done! In addition, I added missing labels via github-label-sync and labels.json at the stylelint/.github repository.

$ npx github-label-sync stylelint/vscode-stylelint --dry-run
...
Syncing labels for "stylelint/vscode-stylelint"
Validating provided labels
Fetching labels from GitHub
 > Added: the "effort: casual" label in the repo is not expected. It will be deleted.
 > Added: the "effort: difficult" label in the repo is not expected. It will be deleted.
 > Added: the "effort: moderate" label in the repo is not expected. It will be deleted.
This is a dry run. No changes have been made on GitHub