-
Notifications
You must be signed in to change notification settings - Fork 11
Open
Description
Issue: Implement Best Practice Labels for Repository
Description
To effectively manage and organize issues in our newly formed repository, we need to create a set of labels based on best practices. These labels will help categorize issues, prioritize work, and provide clarity for contributors.
Labels to Create (Following Best Practices)
-
Type Labels: For categorizing the nature of the issue:
bug: Identifies bugs or errors in the codebase.feature: Suggests new features or improvements.documentation: For documentation-related updates or additions.
-
Priority Labels: To help prioritize issues:
high-priority: Requires immediate attention.medium-priority: Important but not urgent.low-priority: Can be addressed later.
-
Status Labels: For tracking issue progress:
in-progress: Currently being worked on.needs review: Awaiting code review or feedback.blocked: Cannot proceed until a dependency is resolved.
-
Scope Labels: To define areas of the project:
frontend: Related to UI/UX or client-side work.backend: Pertains to server-side or infrastructure tasks.API: For API-related development and fixes.
-
Effort/Size Labels: For estimating task size:
small: Minimal effort required.medium: Moderate effort required.large: Significant effort or time required.
-
Special Labels: For encouraging collaboration and guiding contributors:
help wanted: Indicates issues where assistance is needed.good first issue: Suitable for new or first-time contributors.discussion: Marks issues intended for open-ended discussion or brainstorming.
Tasks
- Create the labels listed above using consistent naming conventions and appropriate color coding based on their category (e.g., type, priority, status).
- Provide clear descriptions for each label to explain when and how they should be used, ensuring consistency and clarity for contributors.
- Document the labels and their intended use in the repository’s contribution guide or
READMEsection.
Acceptance Criteria
- All labels are created with clear names, descriptions, and colors following best practices.
- Labels are available for use and accessible to contributors.
- Documentation on label usage is updated and available in the repository.
Additional Notes
- Regularly review and update labels to keep them relevant and aligned with the project’s evolution.
- Suggestions for additional labels or modifications are welcome to improve organization and efficiency.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels