-
Notifications
You must be signed in to change notification settings - Fork 19
Description
Description
Set up GitHub workflow which automatically gives a gentle reminder to add labels to newly opened issues. It acts as a sanity check to ensure consistent and well-documented issues in Hive Docs.
This workflow should run on the issues: [opened] event and only adds a comment if the issue has zero labels after 30 minutes from the time of creation. This time buffer is to avoid adding comments - before the developer has finished writing the full issue.
Why
Currently, new issues remain unlabelled after being opened. This issue does not address the project labels such as Priority and Estimated Effort yet. Could address them in separate issues if needed. Adding labels on issues are very easy to miss, hence this intends to help developers with these sanity checks.
Why Labels are important?
Ref: https://www.geeksforgeeks.org/git/what-is-github-labels/
-
They help organise and categorise issues, and gives an instant overview of the issue.
bug -> something broken,feature -> new functionality,docs -> documentation improvement.
-
Labels help with automation
- Labels act as signal for trigger automation.
- Ex. Do ... when
buglabel is added. - Ex. Add a comment if no labels exists in the issue.
-
Prioritise team's attention
- Using high, medium and low priority labels.
- Ex. Which high-priority issues are unassigned?
Nice to Haves
- Delete the comment automatically after labels are added. In future PRs.
- Avoid the sleep time as it ties up the runner unnecessarily. This is intended to give developers some time to edit the issue before bot commenting. Might use alternative approaches in future PR for
sleepjob improvement.
Close Criteria
- Create a well-documented workflow for checking labels on issues.