Skip to content
This repository has been archived by the owner on Jun 2, 2023. It is now read-only.

feat: add a bunch of organization-wide labels #61

Merged

Conversation

kdmccormick
Copy link
Collaborator

@kdmccormick kdmccormick commented Apr 27, 2023

Description

This populates labels.yml with a list of labels that will be synced across the openedx GitHub organization. The labels will be synced by Axim using repo_checks.py.

The labels' spelling, color, and description will be made consistent. If a repo has an existing label with similar spelling (that is: ignoring capitalization, emoji, spaces, and special characters) then the label will be edited in-place instead of created anew. So, we shouldn't have a bunch of old-spelling labels lying around when this is done.

The proposed labels.yml is based on the comments on this wiki page.

Considerations

Blocking work

This PR is based on the work from #60, which actually implements the labels.yml syncing. If you want to review the implementation rather than the labels, refer to that PR.

Also, before applying these labels to the org, we need to ensure that:

  • the OSPR bot is no longer managing these labels in openedx repos.
  • the DEPR workflow is no longer trying to add the DEPR label to repos.

Followup work

Once core contributor is added to every repo, we can wrap up: openedx/openedx-webhooks#227

No emoji

I decided not to include emoji in the labels. My driving motivation is that searches/filters become harder to type and harder to read when emoji are involved. Consider:

org:openedx is:open label:epic,initiative,discovery 

versus

org:openedx is:open label:":dizzy: epic",":100: initiative",":mag_right: discovery"

I could be persuaded otherwise; what's most important to me is that we're consistent :)

Things to keep in mind...

  • This is a first pass. We can edit these new labels later. We don't have the machinery to delete labels yet, but we could certainly add that later too if necessary. Anything is better than what we have now.
  • We don't know exactly how these labels should be used, and even if we did, we don't have time to police the community to make sure they're used "correctly". So, rather than trying to design a single perfect workflow, I've tried to provide a set of generally useful set of labels that we can experiment with.
  • Any proposed changes to the CONTRIBUTION WORKFLOW labels should involve @mphilbrick211 and @itsjeyd , as they are the ones that run that process.

@kdmccormick kdmccormick changed the title feat: add initial set of org-wide labels feat: more org-wide labels Apr 27, 2023
@kdmccormick
Copy link
Collaborator Author

FYI @e0d

@kdmccormick kdmccormick changed the title feat: more org-wide labels feat: add a bunch of organization-wide labels Apr 28, 2023
migrate/labels.yml Outdated Show resolved Hide resolved
Copy link

@brian-smith-tcril brian-smith-tcril left a comment

Choose a reason for hiding this comment

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

These are wonderful, and the labels.yml file is extremely easy to read. This makes me super happy!

I left a few comments in there, mostly hoping to start a few conversations. Even if none of the comments I made are addressed I'm happy to say :shipit:!

migrate/labels.yml Outdated Show resolved Hide resolved
migrate/labels.yml Outdated Show resolved Hide resolved
migrate/labels.yml Outdated Show resolved Hide resolved
@brian-smith-tcril brian-smith-tcril added the blocked by other work PR cannot be finished until other work is complete label Apr 28, 2023

- name: "help wanted"
color: "54976d" # fenway green
description: "Ready to be picked up by anyone in the community"
Copy link
Contributor

Choose a reason for hiding this comment

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

Who will be adding this label to issues? Sort of by default, all issues are "help wanted". Is there some specific kind of ready this is meant to indicate other than it's an open issue?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@nedbat To me, the help wanted label is meant to answer the question "I'd like to help with this group/project, what should I work on next?" Consider it a superset of good first issue.

Open issues that wouldn't warrant a help wanted labels are:

  • a "draft" issue; one that hasn't been refined well, maybe something you wrote up quickly with the intent of fleshing out later, like this one.
  • issues that require special permissions, like Axim requests, or certain WG tickets like this one.
  • ones that require special context like this one.
  • issues with a high technical barrier to entry.
  • issues that are part of an actively funded project (ie, someone is already being paid to do it).
  • issues that already have intended assignees, like this one.

Who will be adding this label to issues?

Anyone! I'll be using it for my working group, and I'll encourage other WG leads to as well.

Copy link
Contributor

Choose a reason for hiding this comment

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

This sort of guidance will be good to have somewhere. This file is not discoverable, but I'm not sure where else to put it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

OK, maybe this is something we could add to maintainer playbooks or contribution guides on docs.openedx.org.

That said, I am hoping that the labels can be as self-explanatory as possible. We can't assume potential new contributors will be reading docs.openedx.org, so the more obvious we can make ourselves to the outside world with the tools GitHub gives us, the better.

Is it not reasonably clear what help wanted means?

Copy link
Contributor

Choose a reason for hiding this comment

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

My only concern about "help wanted" is the interpretation that if the label isn't on a PR, then we don't want or need help with it.

My suggestion about putting your guidelines somewhere was not so that new contributors would find them, but so that we who are labelling issues would have a common understanding of the labels.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

My suggestion about putting your guidelines somewhere was not so that new contributors would find them, but so that we who are labelling issues would have a common understanding of the labels.

That makes sense. I think the maintainership playbooks would be a good home for these docs, then.

@wittjeff
Copy link

wittjeff commented May 2, 2023

Labels that I have used across projects at edX:

  • a11y (accessibility-related)
  • WCAG (is a WCAG conformance issue; not all a11y issues are WCAG issues)
  • WCAG 2.0, WCAG 2.1, WCAG 2.2 (specific WCAG standard levels)
    I also tag some things 'WCAG AAA' (refers to specific WCAG standards that are above widely accepted legal minimum) but I don't use that very often.

Copy link

@itsjeyd itsjeyd left a comment

Choose a reason for hiding this comment

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

This looks great @kdmccormick, it'll be great to have a standard set of org-wide labels.

migrate/labels.yml Outdated Show resolved Hide resolved
migrate/labels.yml Outdated Show resolved Hide resolved
migrate/labels.yml Outdated Show resolved Hide resolved
@kdmccormick kdmccormick removed the blocked by other work PR cannot be finished until other work is complete label May 24, 2023
@kdmccormick
Copy link
Collaborator Author

Thank @wittjeff , I went and added a11y as a label. I don't see the other labels used in any of our repositories yet, so I imagine that they being used in 2U's Jira right now, yeah? Feel free to add those WCAG* labels to individual repos as you need, and if you find that you're using them in GitHub regularly, then let's add them at the organization level here.

@kdmccormick kdmccormick marked this pull request as ready for review May 24, 2023 19:18
@kdmccormick
Copy link
Collaborator Author

Comments are addressed; I think this is ready to go. Please let me know by EOD tomorrow (Thurs) if you have any concerns!

@kdmccormick
Copy link
Collaborator Author

Dry-run output: https://gist.github.com/kdmccormick/ae8d40dd2362df440161f66a74342dae

Will merge and apply once I've confirmed that "feat!: don't sync any repo labels" in openedx-webhooks-data (private) are deployed to the bot.

@kdmccormick
Copy link
Collaborator Author

Applying now...

@kdmccormick
Copy link
Collaborator Author

Almost done, but hit GitHub's rate limit. Will finish later.

@kdmccormick
Copy link
Collaborator Author

@kdmccormick kdmccormick merged commit 39d9f6b into openedx-unsupported:main May 31, 2023
2 checks passed
@kdmccormick kdmccormick deleted the kdmccormick/labels-2 branch May 31, 2023 19:35
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants