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

Add descriptions for use_github_labels() #290

Closed
batpigandme opened this issue Feb 24, 2018 · 6 comments
Closed

Add descriptions for use_github_labels() #290

batpigandme opened this issue Feb 24, 2018 · 6 comments

Comments

@batpigandme
Copy link
Member

@batpigandme batpigandme commented Feb 24, 2018

Just ~parking this here as one possible approach. However, it now occurs to me that there's probably an advantage to having this nested as a list somehow…

#' @rdname use_github_labels
#' @export
tidy_labels <- function() {
  data.frame(
    label = c(
      "bug", "feature", "reprex", "wip", "docs", "performance",
      "good first issue", "help wanted"
    ),
    colour = c(
      "e02a2a", "009800", "eb6420", "eb6420", "0052cc", "fbca04",
      "484fb5", "008672"
    ),
    description = c(
      "type; indicates an unexpected problem or unintended behavior.",
      "type; indicates a feature request or enhancement.",
      "indicates that an issue does not have a minimal reproducible example and that a reply has been sent requesting one from the user.",
      "indicates that someone else is working on it or has promised to.",
      "type; indicates an issue with the documentation.",
      "indicates a non-breaking area related to performance.",
      "indicates a good issue for first-time contributors.",
      "indicates that a maintainer wants help on an issue."
    )
  )
}
@batpigandme
Copy link
Member Author

@batpigandme batpigandme commented Feb 24, 2018

Another option that just occurred to me would be to use_label_descriptions() (or something of the like) to just add them to the existing label construct...

#' @rdname use_github_labels
#' @export
tidy_descriptions <- function() {
  c(
    "bug" = "type; indicates an unexpected problem or unintended behavior.",
    "feature" = "type; indicates a feature request or enhancement.",
    "reprex" = "indicates that an issue does not have a minimal reproducible example and that a reply has been sent requesting one from the user.",
    "wip" = "indicates that someone else is working on it or has promised to.",
    "docs" = "type; indicates an issue with the documentation.",
    "performance" = "indicates a non-breaking area related to performance.",
    "good first issue" = "indicates a good issue for first-time contributors.",
    "help wanted" = "indicates that a maintainer wants help on an issue."
  )
}

@hadley
Copy link
Member

@hadley hadley commented Feb 26, 2018

I like the first version best - a tribble() would be a ideal but that would add a tibble dependency which we probably don't want.

We also need a new_label column which includes the emoji; use_github_labels() will need to be updated to also rename existing labels.

@batpigandme
Copy link
Member Author

@batpigandme batpigandme commented Feb 26, 2018

Some possible options…

"bug" = 🐞

"feature" = 🙏

"reprex" = 🔮

"wip" = 🚧

"docs" = 📄

"performance" = 💨 🐢

"good first issue" = 🐣

"help wanted" = 🆘

@batpigandme
Copy link
Member Author

@batpigandme batpigandme commented Feb 27, 2018

tidy_label_frame <- function() {
  data.frame(
    label = c(
      "bug", "feature", "reprex", "wip", "docs", "performance",
      "good first issue", "help wanted"
    ),
    colour = c(
      "e02a2a", "009800", "eb6420", "eb6420", "0052cc", "fbca04",
      "484fb5", "008672"
    ),
    description = c(
      "type; indicates an unexpected problem or unintended behavior",
      "type; indicates a feature request or enhancement",
      "issue does not have a minimal reproducible example; reply has been sent requesting one from the user",
      "indicates that someone else is working on it or has promised to",
      "type; indicates an issue with the documentation",
      "indicates a non-breaking area related to performance",
      "indicates a good issue for first-time contributors",
      "indicates that a maintainer wants help on an issue"
    ),
    emoji = c(
      "bug", "pray", "crystal ball", "construction",
      "page_facing_up", "turtle", "hatching_chick", "sos"
    ),
    new_label = c("bug :bug:", "feature :pray:",
                  "reprex :crystal_ball:", "wip :construction:", "docs :page_facing_up:",
                  "performance :turtle:", "good first issue :hatching_chick:",
                  "help wanted :sos:")
  )
}

image

@hadley
Copy link
Member

@hadley hadley commented May 22, 2018

I now think that we should reserve emoji for use in topic labels (i.e. repo specific labels with colour #eee)

@maelle
Copy link
Contributor

@maelle maelle commented Jul 16, 2018

use_github_labels() will need to be updated to also rename existing labels.
just commenting to say that it'd be a fantastic feature! it'd have saved me work in https://itsalocke.com/blog/harmonizing-and-emojifying-our-github-issue-trackers/

@hadley hadley added the git label Nov 24, 2018
hadley added a commit that referenced this issue Nov 29, 2018
Also make the repo customisation (to make interactive testing easier)

Fixes #290
@hadley hadley added the wip label Nov 29, 2018
@hadley hadley closed this in 4f717b0 Nov 29, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants