iTranslated by AI
About GitHub Labels
About GitHub Labels
"I want to do OSS development."
Driven by long-standing admiration, I started OSS development without fully understanding what it entails.
Once I started, I found myself surrounded by things I didn't know.
I will research and understand things starting from the basics.
Although I tried writing an Issue, I'm unsure about what to set in the right-hand column.
First, I thought about what to set for "Labels."
Benefits of Using Labels
When you write an Issue or Pull Request, the title is displayed in the list.
If you add a Label, it will be displayed next to the title.
- You can see which labels are set when viewing the list
- You can filter by label
- You can set multiple labels
You can choose which labels to filter by clicking "Labels" in the header section.
About Default Labels
When you create a repository on GitHub, the following default labels are available.
Checking the official documentation, each label is explained as follows.
| Label | Description |
|---|---|
| bug | Indicates an unexpected problem or unintended behavior |
| documentation | Indicates that improvements or additions to documentation are needed |
| duplicate | Indicates similar issues, pull requests, or discussions |
| enhancement | New feature requests |
| good first issue | Indicates an issue suitable for first-time contributors |
| help wanted | Indicates that maintainers are seeking help with an issue or pull request |
| invalid | Indicates that an issue, pull request, or discussion is no longer relevant |
| question | Indicates that more information is needed for an issue, pull request, or discussion |
| wontfix | Indicates that work will not continue on an issue, pull request, or discussion |
Editing Labels
The descriptions make sense upon reading.
However, I want to make it easy for even those unfamiliar with GitHub to write issues, so I decided to edit the labels.
Clicking "Labels" within the "Issues" tab takes you to the labels list.
You can also navigate there by appending "labels" to the end of your repository URL.
https://github.com/posita33/(repository-name)/labels
Click "New label" or "Edit" on an existing label.
Set the following items and click "Save changes."
| Item | Description |
|---|---|
| Label name | The name of the label |
| Description | A description of the label |
| Color | Label color (click the refresh button for a random color) |
You can use emojis in "Label name" and "Description."
Since I have just started OSS development, I added, edited, and deleted labels to make them more intuitive and easier to use.
| Label | Description | |
|---|---|---|
| - | 🌱In Development | Currently in development |
| enhancement | ⛏Feature Request | For requesting new features |
| - | 🍔Other | Doesn't fit existing labels (for new label consideration) |
| bug | 🐞Bug/Issue Report | For reporting a problem |
| question | 💬Question | For questions about the content |
| document | 📝Documentation | For adding or editing documentation |
If an issue doesn't fit any of the categories, I'll have them use "🍔Other."
When "🍔Other" is used, I will consider creating a new label.
Reference URLs
Discussion