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

Rationalise the common GitHub issue configuration #4

Merged
merged 5 commits into from
Jan 11, 2023
Merged

Conversation

freakboy3742
Copy link
Member

Update the Github label configuration to:

  1. Use names and colors consistent with Github defaults
  2. Remove some stale and unhelpful labels

Also adds some documentation so it's we know how to use this in future.

Refs beeware/briefcase#1003.

PR Checklist:

  • All new features have been tested
  • All new features have been documented
  • I have read the CONTRIBUTING.md file
  • I will abide by the code of conduct

Comment on lines 22 to 23
# labels sync -n -f -o beeware -r toga
#
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
# labels sync -n -f -o beeware -r toga
#
# labels sync -o beeware -r toga

-n must be removed to actually run the update.

# 4. cd into the .github folder where the labels.toml file is stored
# 5. Perform a dry run for a specific repo (say beeware/toga):
#
# labels sync -n -f -o beeware -r toga
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
# labels sync -n -f -o beeware -r toga
# labels sync -n -o beeware -r toga

If I understand the labels documentation correctly, -f requires an argument, and is unnecessary if labels.toml is in the working directory.

description = "Is this your first time contributing? This could be a good place to start!"

[more-details]
color = "d876e3"
name = "more details"
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
name = "more details"
name = "awaiting details"

Clarify that the issue needs more details, not that it already contains them.

@mhsmith
Copy link
Member

mhsmith commented Jan 10, 2023

Looks like I don't have write access to this repository, so I can't merge the PR.

@freakboy3742
Copy link
Member Author

I swear I'll get these permissions right eventually...

@freakboy3742 freakboy3742 merged commit 6bb450f into main Jan 11, 2023
@freakboy3742 freakboy3742 deleted the issue-labels branch January 11, 2023 00:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants