GitHub_Labels
All DCC-EX issues and pull requests should have appropriate labels applied to assist organising, prioritising, and assigning tasks and allow ease of filtering on the DCC++ EX project board.
To make this easy, a Python script has been written to ensure repositories have these labels created.
To use the script, you will need to install a recent version of Python 3 (it was written and tested with 3.10.6), set up a virtual environment, and install the requirements listed in "requirements.txt".
Once Python is installed, the remaining steps are:
- virtualenv venv
- venv/scripts/activate
- pip install -r requirements.txt
To run the script, you need to provide the owner (or organisation) name of the repository, the repository name, the name of the JSON file containing the label data, and your personal access token.
For example:
python manage-github-labels.py -o DCC-EX -r exInstaller -t <Your personal access token> -f labels.json
| Label | Colour | Colour Code | Purpose |
|---|---|---|---|
| Alpha Testing | Lt Purple | #D4C5F9 | Item relates to a feature in Alpha testing |
| Beta Testing | Lt Yellow | #FEF2C0 | Item relates to a feature in Beta testing |
| Breaking Change | Orange/Red | #D93F0B | Indicates that the bug fix or new feature introduces a breaking change |
| Bug | Red | #B60205 | Something isn't working as designed |
| Documentation | Blue | #1D76DB | Item relates to documentation |
| Documented | Green | #0E8A16 | Item that was previously labelled "Needs Documentation" has had this completed |
| Enhancement | Lt Blue | #C5DEF5 | New feature or request |
| EX-CommandStation | Dk Blue | #0052CC | Item relates to the core EX-CommandStation code |
| EX-DCCInspector | Purple | #A239E4 | Item relates to EX-DCCInspector |
| EX-Installer | Green/Blue | #006B75 | Item relates to EX-Installer |
| EX-IOExpander | Green/Blue | #006B75 | Item relates to EX-IOExpander |
| EX-RAIL | Green/Blue | #006B75 | Item relates to EX-RAIL automation |
| EX-Turntable | Green/Blue | #006B75 | Item relates to EX-Turntable specifically |
| EX-WebThrottle | Green/Blue | #006B75 | Item relates to EX-WebThrottle specifically |
| Hardware | Purple | #5319E7 | Item relates to hardware |
| Needs Clarification | Yellow | #FBCA04 | Need more information from the requestor |
| Needs Documentation | Yellow | #FBCA04 | Item requires supporting documentation |
| Needs Review | Yellow | #FBCA04 | Item requires review |
| Needs Testing | Yellow | #FBCA04 | Item has not been unit and/or regression testing |
| Regression Tested | Green | #0E8A16 | Regression testing has been completed |
| Reviewed | Green | #0E8A16 | Item previously labelled "Needs Review" has been reviewed |
| Support Request | Orange/Red | #D93F0B | Item is a request for support |
| To Do | Lt Yellow | #FEF2C0 | General work task to be completed |
| Unit Tested | Lt Green | #C2E0C6 | Unit testing has been completed |
| Will Not Fix | White | #FFFFFF | Feature will not be implemented, or bug will not be fixed |
team ways of working.