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

github: add specifier to github issue labels #13545

Merged
merged 1 commit into from
Sep 20, 2024

Conversation

raiden00pl
Copy link
Contributor

@raiden00pl raiden00pl commented Sep 19, 2024

Summary

This change adds a specifier to github labels created with "new issue":

  • for labels related to architecture specifier is "Arch: xxx"
  • for labels related to issue type specifier is "Type: xxx"
  • for labels related to host OS type specifier is "OS: xxx"
  • for labels related to issue area type specifier is "Area: xxx"

Impact

with this PR the labels will be more readable and they'll be displayed grouped according to the specifier.
After the PR is merged, the labels in github need to be updated accordingly (label name and color): https://github.com/apache/nuttx/labels

Related issue (doesn't solve it completely): #13522

Testing

tested on private repo and below is the result (https://github.com/raiden00pl/nuttx/issues)

image

I just chose random colors for the above test

@nuttxpr
Copy link

nuttxpr commented Sep 19, 2024

[Experimental Bot, please feedback here]

NuttX PR Requirements Review

Meets Requirements? Partially

Summary: The summary clearly explains the change and its purpose. However, it lacks references to related issues if any.

Impact:

  • New Feature: YES
  • User Impact: YES - Users will need to adapt to the new label names and organization.
  • Build Impact: NO
  • Hardware Impact: NO
  • Documentation Impact: YES - Documentation should be updated to reflect the new label naming convention.
  • Security Impact: NO
  • Compatibility Impact: Potentially - Existing workflows or tools relying on the old label names might be affected.

Testing:

  • Testing on a private repo is a good start. However, testing on the actual apache/nuttx repository is crucial before merging.
  • The "Testing logs" sections are not applicable in this case as the change primarily affects GitHub labels, not code execution. Screenshots demonstrating the label organization are helpful.

Recommendations:

  1. Related Issues: Link any related NuttX issues to provide context.
  2. Testing: Perform a test run on a fork of the apache/nuttx repository to ensure compatibility.
  3. Documentation: Update relevant documentation to reflect the new label structure.
  4. Impact on Compatibility: Elaborate on potential compatibility issues with existing workflows.

Overall: The PR addresses a valid need for label organization. Addressing the recommendations will ensure a smoother integration and adoption of this change.

@simbit18
Copy link
Contributor

@raiden00pl now you also need to change the text and color of the labels.

@raiden00pl
Copy link
Contributor Author

@simbit18 Yes, I'll start working on it once PR is merged or at least it gets some approvals

@simbit18
Copy link
Contributor

Then we need to remember to do the same on the apps repository. :)

@github-actions github-actions bot added the Size: M The size of the change in this PR is medium label Sep 19, 2024
This change adds a specifier to github lables created with "new issue":

- for labels related to architecture specifier is "Arch: xxx"
- for labels related to issue type specifier is "Type: xxx"
- for labels related to host OS type specifier is "OS: xxx"
- for labels related to issue area type specifier is "Area: xxx"
@raiden00pl raiden00pl changed the title github: add specifier to issue github labels github: add specifier to github issue labels Sep 20, 2024
@raiden00pl raiden00pl closed this Sep 20, 2024
@raiden00pl raiden00pl deleted the update_labels branch September 20, 2024 09:19
@raiden00pl raiden00pl restored the update_labels branch September 20, 2024 09:19
@raiden00pl raiden00pl reopened this Sep 20, 2024
@xiaoxiang781216 xiaoxiang781216 merged commit ff24fc4 into apache:master Sep 20, 2024
58 checks passed
@raiden00pl raiden00pl deleted the update_labels branch September 20, 2024 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Size: M The size of the change in this PR is medium
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants