Skip to content
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.

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

Document labels for issues and PRs #339

Open
magnusbaeck opened this issue Dec 12, 2022 · 1 comment
Open

Document labels for issues and PRs #339

magnusbaeck opened this issue Dec 12, 2022 · 1 comment

Comments

@magnusbaeck
Copy link
Member

Description

We've recently started to use a couple of issue/PR labels (protocol and protocol-incompat), partly for general filtering but also to be able to generate release notes automatically. However, labeling issues and PRs correctly requires that we have a common understanding of what they actually mean. Let's document what the labels mean. Perhaps we can get away with simply good label descriptions at https://github.com/eiffel-community/eiffel/labels, otherwise we'll have to create or amend a Markdown document.

Motivation

If we ask people to categorize issues and PRs there should be guidance so that labels are applied consistently.

Exemplification

N/A

Benefits

More accurate labels

Possible Drawbacks

There's no immediately obvious documentation location besides the description of the label itself, but if that's deemed insufficient we might end up with documentation that's hard to find and mostly piles onto the maintenance burden.

@magnusbaeck
Copy link
Member Author

Questions that have come up:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

2 participants