Skip to content

Commit

Permalink
new labels
Browse files Browse the repository at this point in the history
  • Loading branch information
JoschD committed Sep 10, 2024
1 parent 26f0a8c commit d8cf80c
Show file tree
Hide file tree
Showing 9 changed files with 187 additions and 16 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: "🐞 Bug Report"
description: Report an issue with the package
description: Report an issue with the package in detail
title: "[Bug]: "
labels: ["Bug"]
labels: ["Type: Bug"]
body:
- type: markdown
attributes:
Expand Down
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_short.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: "🐞 Quick Bug Report"
description: Report an issue with the package
title: "[Bug]: "
labels: ["Type: Bug"]
body:
- type: markdown
attributes:
value: |
Before opening a bug report, please search if the problematic behavior has already been reported in the existing issues
and read the relevant documentation. Thank you for taking the time to file a bug report.
- type: textarea
id: description
attributes:
label: Bug Description
description: Give us a clear and concise description of the problem and the expected behavior.
validations:
required: true
4 changes: 1 addition & 3 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: "📚 Documentation"
description: Suggest edits or additions for the documentation
title: "[Documentation]: "
labels: ["Enhancement", "Documentation"]
labels: ["Type: Feature", "Type: Documentation"]
body:
- type: markdown
attributes:
Expand All @@ -23,8 +23,6 @@ body:
label: Pertinent Section
description: "Please provide a permalink to the relevant section heading in the documentation. Choose the most specific section / lowest-level heading to which your suggested change would apply."
placeholder: "https://pylhc.github.io/..."
validations:
required: true

- type: textarea
id: description
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: "🚀 Feature Request"
description: Propose a new feature for the package
title: "[Feature Request]: "
labels: ["Enhancement", "Feature Request"]
labels: ["Type: Feature"]
body:
- type: markdown
attributes:
Expand Down
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/other.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: "👀 Other"
description: Everything that does not fit with the other type of issues.
body:
- type: textarea
id: content
attributes:
label: Content
validations:
required: true
11 changes: 1 addition & 10 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -1,22 +1,13 @@
name: "🙋 Ask a Question"
description: Discuss questions you have about the software
title: "[Question]: "
labels: ["Help", "Question"]
labels: ["Type: Question"]
body:
- type: markdown
attributes:
value: |
We are happy to get feedback and help users of our packages. Let's discuss!
- type: checkboxes
id: terms
attributes:
label: Documentation
description: Have you read the relevant documentation before asking your question?
options:
- label: "Yes"
required: true

- type: textarea
id: question
attributes:
Expand Down
127 changes: 127 additions & 0 deletions .github/assets/labels.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
[
{
"name": "Domain: GUI",
"color": "#8F12C9",
"aliases": ["GUI"],
"description": "Closely related to GUI and/or needs GUI changes as well."
},
{
"name": "Domain: Physics",
"color": "#EF8206",
"aliases": [],
"description": "The implementation is closely related to new physics to be used."
},
{
"name": "Type: Bug",
"color": "#FC060A",
"aliases": ["Bug", "Bugfix"],
"description": "Something isn't working as it should."
},
{
"name": "Type: Maintenance",
"color": "#fbca04",
"aliases": ["Maintenance"],
"description": "Improvements in the code, that are not necessarily visible in functionality."
},
{
"name": "Type: Feature",
"color": "#047CFD",
"aliases": ["Feature", "Enhancement"],
"description": "A (suggetion for) a new feature or enhancement in functionality."
},
{
"name": "Type: Question",
"color": "#FD067D",
"aliases": ["Question"],
"description": "Something is not clear or is not understood."
},
{
"name": "Type: Documentation",
"color": "#95FD04",
"aliases": ["Documentation"],
"description": "Improvements, updates and fixes to the documentation."
},
{
"name": "Type: CI/CD",
"color": "#646464",
"aliases": ["CI/CD"],
"description": "Improvements, updates and fixes to the continuous integration."
},
{
"name": "Type: Release",
"color": "#00E5FF",
"aliases": ["Release"],
"description": "Issue preparing for a release."
},
{
"name": "Status: Blocked",
"color": "#FDA8A9",
"aliases": [],
"description": "Cannot be worked on until something else happens (e.g. closing other issues)."
},
{
"name": "Status: In Progress",
"color": "#A1DCF7",
"aliases": [],
"description": "Currently being worked on."
},
{
"name": "Status: On Hold",
"color": "#B5A6F9",
"aliases": [],
"description": "Work currently stopped, but not for blocking reasons."
},
{
"name": "Status: Review Needed",
"color": "#FBE9A3",
"aliases": [],
"description": "Work currently stopped, untils someone else reviews it."
},
{
"name": "Status: Wontfix",
"color": "#DDDDDD",
"aliases": ["Wontfix"],
"description": "Cannot or should not be fixed."
},
{
"name": "Estimate: Easy",
"color": "#004709",
"aliases": ["Good First Issue"],
"description": "Good first issue for newcomers. Straightforward fixes."
},
{
"name": "Estimate: Normal",
"color": "#010545",
"aliases": [],
"description": "Straightforward, but might require some time. Probably needs additional tests."
},
{
"name": "Estimate: Complicated",
"color": "#540101",
"aliases": [],
"description": "Might need some major overhaul of the code."
},
{
"name": "Priority: Low",
"color": "#79CE38",
"aliases": ["Minor Issue"],
"description": "Work on this if you have some spare time."
},
{
"name": "Priority: Medium",
"color": "#D8D51F",
"aliases": [],
"description": "Work on this."
},
{
"name": "Priority: High",
"color": "#C65339",
"aliases": ["Important Issue"],
"description": "Work on this!"
},
{
"name": "Priority: Critical",
"color": "#CA3538",
"description": "Work on this!!"
}
]
4 changes: 4 additions & 0 deletions .github/assets/labels_readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# About Labels

The labels have been defined with [github-label-sync](https://github.com/Financial-Times/github-label-sync)
in mind.
24 changes: 24 additions & 0 deletions .github/workflows/assign_labels_to_all_repos.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Assign labels from json definition to all repos
# This uses https://github.com/Financial-Times/github-label-sync

name: Assign labels to all repos

on: # Runs on any push event in a PR or any push event to master
push:
branches:
- 'issue_redesign'

defaults:
run:
shell: bash

jobs:
run-test:
runs-on: ubuntu-latest
steps:
- name: install github-label-sync
run: |
npm install -g github-label-sync
- name: Install into all repos
run: |
github-label-sync --labels .github/assets/labels.json pylhc/optics_functions

0 comments on commit d8cf80c

Please sign in to comment.