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

518 feature move priority planning from labels to the project board #519

Conversation

SirMDA
Copy link
Collaborator

@SirMDA SirMDA commented Nov 23, 2024

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes #518

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

Does this PR introduce a breaking change?

No

Most important changes

Issue templates are updated and documentation for using project board is updated

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works (might be obsolete with CI later on)
  • New and existing unit tests pass locally with my changes (might be obsolete with CI later on)

Summary by CodeRabbit

  • New Features
    • Updated issue templates for bugs and features to streamline reporting by removing the "Effort Estimate" field.
    • Introduced a structured labeling system for prioritization and size categorization of issues, including urgency levels and estimated timeframes.
  • Documentation
    • Enhanced guidelines in the project management document to include detailed instructions on issue categorization and project board tracking.

@SirMDA SirMDA linked an issue Nov 23, 2024 that may be closed by this pull request
5 tasks
Copy link
Contributor

coderabbitai bot commented Nov 23, 2024

Walkthrough

The changes in this pull request involve modifications to several GitHub issue templates and project management documentation. Specifically, the "Effort Estimate" input field has been removed from the bug, feature, and general issue templates. In its place, a new structured labeling system has been introduced, detailing priority and size categories for issues. Additionally, the project management document has been updated to include guidelines for using these labels effectively.

Changes

File Change Summary
.github/ISSUE_TEMPLATE/BUG.yml Removed "Effort Estimate" field; added detailed labeling system for priority and size categorization.
.github/ISSUE_TEMPLATE/FEATURE.yml Removed "Effort Estimate" field; updated to include new project board labels for priority and size.
.github/ISSUE_TEMPLATE/ISSUE.yml Removed "Effort Estimate" field; added "Add Labels on the Project Board" section with priority and size labels.
doc/development/project_management.md Added guidelines for managing issues with a structured approach to priority and size categorization.

Assessment against linked issues

Objective Addressed Explanation
Remove the priority labels as they are replaced by the project board priorities (518)
Markdown is created on which metrics we will use and which one is going to be deleted (518) No markdown was created regarding metrics.
Markdown includes examples on how they should be used to have a guide for everyone (518) No examples or guide provided.

Possibly related PRs

  • 279 feature add empty issue template #341: The changes in the .github/ISSUE_TEMPLATE/ISSUE.yml file involve the removal of the "Effort Estimate" input field and the addition of a detailed labeling system, which aligns with the modifications made in the main PR.
  • Feat: Update sprint planning guidelines #344: The update to the .github/ISSUE_TEMPLATE/FEATURE.yml file also removes the "Effort Estimate" field and introduces a structured labeling system, similar to the changes in the main PR.
  • Update Project Management and PR #351: The modifications in doc/development/project_management.md include a structured approach to categorizing issues based on priority and size, which complements the labeling system introduced in the main PR.
  • updated issue templates #463: The updates to the .github/ISSUE_TEMPLATE/BUG.yml file include the addition of a "Definition of Done" and "Effort Estimate" fields, which are relevant to the overall context of issue templates and their structure, although they differ from the main PR's focus on removing the effort estimate.

Suggested reviewers

  • asamluka

Poem

In the garden of issues, we play,
No more estimates lead us astray.
With labels bright, we now can see,
Priorities clear as can be!
Tiny to X-Large, we categorize,
Hop along, let clarity rise! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🧹 Outside diff range and nitpick comments (12)
.github/ISSUE_TEMPLATE/FEATURE.yml (3)

56-59: Consider separating time estimates from size labels.

Time estimates embedded in size labels might become outdated or vary based on team composition and project complexity. Consider moving these to a separate guideline document that can be updated more easily.


60-61: Fix formatting inconsistency in X-Large description.

The line wrapping for the X-Large description is inconsistent with other entries.

-        - `X-Large`: Large-scale feature or complete module overhaul. Estimated time: 2-4 weeks. Especially `EPIC` issues should
-          be tagged with this size.
+        - `X-Large`: Large-scale feature or complete module overhaul. Estimated time: 2-4 weeks. Especially `EPIC` issues should be tagged with this size.

49-61: Add guidance on combining priority and size labels.

The template should provide guidance on how to use priority and size labels together effectively.

Add a note like:

        **Size:**
        - `Tiny`: Small typo fix or minor code refactor. Estimated time: 30 minutes.
        ...
+
+        **Note:** Each issue should have both a priority and size label assigned. For example, a small but urgent feature would be labeled as `Urgent` + `Small`.
doc/development/project_management.md (5)

16-18: Add context about the transition from labels to project board.

While the section correctly introduces the project board requirement, it would be helpful to add context about why we're transitioning from labels to the project board system. This helps users understand the motivation behind the change.

-After creating the issue it has to be added to the project board. The project board is used to keep track of the 
-progress of the issue. The project board can be found [here](https://github.com/orgs/una-auxme/projects/3).
+After creating the issue, it must be added to the project board. We are transitioning from using labels to the project
+board for better organization and visibility. The project board, which can be found [here](https://github.com/orgs/una-auxme/projects/3),
+is used to track the progress of issues and manage priorities effectively.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~16-~16: Possible missing comma found.
Context: ...o create the issue. After creating the issue it has to be added to the project board...

(AI_HYDRA_LEO_MISSING_COMMA)

🪛 Markdownlint (0.35.0)

16-16: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


19-21: Clarify that these are project board fields.

The introduction should explicitly mention that these are fields within the project board to avoid confusion.

-For tracking time and complexity of the issue we will use the predefined `Priority` and `Size` states of the PAF Project
-Backlog Board.
+For tracking time and complexity of the issue, we will use the predefined `Priority` and `Size` fields available in the
+PAF Project Backlog Board. These fields replace our previous label-based system.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~19-~19: Possible missing comma found.
Context: ...For tracking time and complexity of the issue we will use the predefined Priority a...

(AI_HYDRA_LEO_MISSING_COMMA)


22-27: Improve formatting and clarity of priority states.

The priority states section needs some formatting improvements and could benefit from additional context.

-Priority has following states:
+Priority has the following states:
+
 - `Urgent`: Critical bug causing system crash, needs immediate fix.
 - `High`: Major feature request or significant bug affecting many users.
 - `Medium`: Minor feature request or bug with a workaround.
 - `Low`: Cosmetic changes or minor improvements.
+

Also, consider adding a note about how these priorities are set and who has the authority to change them.

🧰 Tools
🪛 LanguageTool

[grammar] ~22-~22: The article ‘the’ may be missing.
Context: ...AF Project Backlog Board. Priority has following states: - Urgent: Critical bug causing syste...

(HAVE_FOLLOWING_NN)


[uncategorized] ~24-~24: Loose punctuation mark.
Context: ...tem crash, needs immediate fix. - High: Major feature request or significant bu...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...ant bug affecting many users. - Medium: Minor feature request or bug with a wor...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~26-~26: Loose punctuation mark.
Context: ...equest or bug with a workaround. - Low: Cosmetic changes or minor improvements....

(UNLIKELY_OPENING_PUNCTUATION)

🪛 Markdownlint (0.35.0)

23-23: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


28-35: Improve formatting and clarity of size states.

The size states section needs formatting improvements and could benefit from additional context about estimation practices.

-Size has following states:
+Size has the following states:
+
-  - `Tiny`: Small typo fix or minor code refactor. Estimated time: 30 minutes.
-  - `Small`: Simple bug fix or small feature addition. Estimated time: 1-2 hours.
-  - `Medium`: Moderate feature addition or multiple bug fixes. Estimated time: 1-2 days.
-  - `Large`: Major feature implementation or significant refactor. Estimated time: 1-2 weeks.
-  - `X-Large`: Large-scale feature or complete module overhaul. Estimated time: 2-4 weeks. Especially `EPIC` issues should
-    be tagged with this size.
+  - `Tiny`: Small typo fix or minor code refactor. Estimated time: 30 minutes.
+  - `Small`: Simple bug fix or small feature addition. Estimated time: 1–2 hours.
+  - `Medium`: Moderate feature addition or multiple bug fixes. Estimated time: 1–2 days.
+  - `Large`: Major feature implementation or significant refactor. Estimated time: 1–2 weeks.
+  - `X-Large`: Large-scale feature or complete module overhaul. Estimated time: 2–4 weeks. Especially `EPIC` issues should
+    be tagged with this size.

Consider adding:

  1. A note about how these estimates should be used (e.g., for planning purposes only)
  2. Guidelines for breaking down X-Large/EPIC issues into smaller tasks
🧰 Tools
🪛 LanguageTool

[grammar] ~28-~28: The article ‘the’ may be missing.
Context: ...hanges or minor improvements. Size has following states: - Tiny: Small typo fix or minor code...

(HAVE_FOLLOWING_NN)


[uncategorized] ~30-~30: Loose punctuation mark.
Context: ...r. Estimated time: 30 minutes. - Small: Simple bug fix or small feature additio...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~30-~30: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...small feature addition. Estimated time: 1-2 hours. - Medium: Moderate feature add...

(HYPHEN_TO_EN)


[uncategorized] ~31-~31: Loose punctuation mark.
Context: ...n. Estimated time: 1-2 hours. - Medium: Moderate feature addition or multiple b...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~31-~31: If specifying a range, consider using an en dash instead of a hyphen.
Context: ... or multiple bug fixes. Estimated time: 1-2 days. - Large: Major feature implemen...

(HYPHEN_TO_EN)


[uncategorized] ~32-~32: Loose punctuation mark.
Context: ...xes. Estimated time: 1-2 days. - Large: Major feature implementation or signifi...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~32-~32: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...r significant refactor. Estimated time: 1-2 weeks. - X-Large: Large-scale feature...

(HYPHEN_TO_EN)


[uncategorized] ~33-~33: Loose punctuation mark.
Context: .... Estimated time: 1-2 weeks. - X-Large: Large-scale feature or complete module ...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~33-~33: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...mplete module overhaul. Estimated time: 2-4 weeks. Especially EPIC issues should ...

(HYPHEN_TO_EN)

🪛 Markdownlint (0.35.0)

29-29: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


16-35: Add transition guidance from labels to project board.

The documentation effectively describes the new system but doesn't address the transition from labels. Consider adding:

  1. A note about the deprecation of priority labels
  2. Instructions for transitioning existing issues
  3. A timeline for the transition

This will help users understand how to handle existing issues and when to start using the new system.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~16-~16: Possible missing comma found.
Context: ...o create the issue. After creating the issue it has to be added to the project board...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~19-~19: Possible missing comma found.
Context: ...For tracking time and complexity of the issue we will use the predefined Priority a...

(AI_HYDRA_LEO_MISSING_COMMA)


[grammar] ~22-~22: The article ‘the’ may be missing.
Context: ...AF Project Backlog Board. Priority has following states: - Urgent: Critical bug causing syste...

(HAVE_FOLLOWING_NN)


[uncategorized] ~24-~24: Loose punctuation mark.
Context: ...tem crash, needs immediate fix. - High: Major feature request or significant bu...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...ant bug affecting many users. - Medium: Minor feature request or bug with a wor...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~26-~26: Loose punctuation mark.
Context: ...equest or bug with a workaround. - Low: Cosmetic changes or minor improvements....

(UNLIKELY_OPENING_PUNCTUATION)


[grammar] ~28-~28: The article ‘the’ may be missing.
Context: ...hanges or minor improvements. Size has following states: - Tiny: Small typo fix or minor code...

(HAVE_FOLLOWING_NN)


[uncategorized] ~30-~30: Loose punctuation mark.
Context: ...r. Estimated time: 30 minutes. - Small: Simple bug fix or small feature additio...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~30-~30: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...small feature addition. Estimated time: 1-2 hours. - Medium: Moderate feature add...

(HYPHEN_TO_EN)


[uncategorized] ~31-~31: Loose punctuation mark.
Context: ...n. Estimated time: 1-2 hours. - Medium: Moderate feature addition or multiple b...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~31-~31: If specifying a range, consider using an en dash instead of a hyphen.
Context: ... or multiple bug fixes. Estimated time: 1-2 days. - Large: Major feature implemen...

(HYPHEN_TO_EN)


[uncategorized] ~32-~32: Loose punctuation mark.
Context: ...xes. Estimated time: 1-2 days. - Large: Major feature implementation or signifi...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~32-~32: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...r significant refactor. Estimated time: 1-2 weeks. - X-Large: Large-scale feature...

(HYPHEN_TO_EN)


[uncategorized] ~33-~33: Loose punctuation mark.
Context: .... Estimated time: 1-2 weeks. - X-Large: Large-scale feature or complete module ...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~33-~33: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...mplete module overhaul. Estimated time: 2-4 weeks. Especially EPIC issues should ...

(HYPHEN_TO_EN)

🪛 Markdownlint (0.35.0)

16-16: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


23-23: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


29-29: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

.github/ISSUE_TEMPLATE/ISSUE.yml (3)

74-75: Fix formatting for X-Large description

The line wrapping for the X-Large description appears inconsistent. Consider reformatting for better readability.

-        - `X-Large`: Large-scale feature or complete module overhaul. Estimated time: 2-4 weeks. Especially `EPIC` issues should
-          be tagged with this size.
+        - `X-Large`: Large-scale feature or complete module overhaul. Estimated time: 2-4 weeks. Especially `EPIC` issues should be tagged with this size.

70-74: Consider making time estimates more flexible

The current time estimates are very specific. Consider using ranges or more flexible wording to account for varying team velocities and project complexities.

Example modification:

-        - `Tiny`: Small typo fix or minor code refactor. Estimated time: 30 minutes.
-        - `Small`: Simple bug fix or small feature addition. Estimated time: 1-2 hours.
-        - `Medium`: Moderate feature addition or multiple bug fixes. Estimated time: 1-2 days.
-        - `Large`: Major feature implementation or significant refactor. Estimated time: 1-2 weeks.
+        - `Tiny`: Small typo fix or minor code refactor. Usually completed within hours.
+        - `Small`: Simple bug fix or small feature addition. Typically takes a day or less.
+        - `Medium`: Moderate feature addition or multiple bug fixes. Usually takes several days.
+        - `Large`: Major feature implementation or significant refactor. May take up to a few weeks.

61-75: Document transition plan for existing issues

The new labeling system looks good, but we should consider adding documentation about:

  1. How to handle existing issues with old priority labels
  2. Whether existing issues need to be re-labeled
  3. Timeline for the transition

Would you like me to help create a transition guide document or update the project management documentation?

.github/ISSUE_TEMPLATE/BUG.yml (1)

71-76: Consider removing specific time estimates from size categories

Time estimates in templates can become outdated and misleading. Consider focusing on complexity or scope instead.

-        - `Tiny`: Small typo fix or minor code refactor. Estimated time: 30 minutes.
-        - `Small`: Simple bug fix or small feature addition. Estimated time: 1-2 hours.
-        - `Medium`: Moderate feature addition or multiple bug fixes. Estimated time: 1-2 days.
-        - `Large`: Major feature implementation or significant refactor. Estimated time: 1-2 weeks.
-        - `X-Large`: Large-scale feature or complete module overhaul. Estimated time: 2-4 weeks. Especially `EPIC` issues should
-          be tagged with this size.
+        - `Tiny`: Small typo fix or minor code refactor
+        - `Small`: Simple bug fix affecting a single component
+        - `Medium`: Bug fix affecting multiple components
+        - `Large`: Complex bug requiring significant architectural changes
+        - `X-Large`: System-wide bug requiring extensive refactoring or redesign. Typically used for EPIC issues.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5c0606c and 9c40f31.

📒 Files selected for processing (4)
  • .github/ISSUE_TEMPLATE/BUG.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/FEATURE.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/ISSUE.yml (1 hunks)
  • doc/development/project_management.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
doc/development/project_management.md

[uncategorized] ~16-~16: Possible missing comma found.
Context: ...o create the issue. After creating the issue it has to be added to the project board...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~19-~19: Possible missing comma found.
Context: ...For tracking time and complexity of the issue we will use the predefined Priority a...

(AI_HYDRA_LEO_MISSING_COMMA)


[grammar] ~22-~22: The article ‘the’ may be missing.
Context: ...AF Project Backlog Board. Priority has following states: - Urgent: Critical bug causing syste...

(HAVE_FOLLOWING_NN)


[uncategorized] ~24-~24: Loose punctuation mark.
Context: ...tem crash, needs immediate fix. - High: Major feature request or significant bu...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...ant bug affecting many users. - Medium: Minor feature request or bug with a wor...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~26-~26: Loose punctuation mark.
Context: ...equest or bug with a workaround. - Low: Cosmetic changes or minor improvements....

(UNLIKELY_OPENING_PUNCTUATION)


[grammar] ~28-~28: The article ‘the’ may be missing.
Context: ...hanges or minor improvements. Size has following states: - Tiny: Small typo fix or minor code...

(HAVE_FOLLOWING_NN)


[uncategorized] ~30-~30: Loose punctuation mark.
Context: ...r. Estimated time: 30 minutes. - Small: Simple bug fix or small feature additio...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~30-~30: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...small feature addition. Estimated time: 1-2 hours. - Medium: Moderate feature add...

(HYPHEN_TO_EN)


[uncategorized] ~31-~31: Loose punctuation mark.
Context: ...n. Estimated time: 1-2 hours. - Medium: Moderate feature addition or multiple b...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~31-~31: If specifying a range, consider using an en dash instead of a hyphen.
Context: ... or multiple bug fixes. Estimated time: 1-2 days. - Large: Major feature implemen...

(HYPHEN_TO_EN)


[uncategorized] ~32-~32: Loose punctuation mark.
Context: ...xes. Estimated time: 1-2 days. - Large: Major feature implementation or signifi...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~32-~32: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...r significant refactor. Estimated time: 1-2 weeks. - X-Large: Large-scale feature...

(HYPHEN_TO_EN)


[uncategorized] ~33-~33: Loose punctuation mark.
Context: .... Estimated time: 1-2 weeks. - X-Large: Large-scale feature or complete module ...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~33-~33: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...mplete module overhaul. Estimated time: 2-4 weeks. Especially EPIC issues should ...

(HYPHEN_TO_EN)

🪛 Markdownlint (0.35.0)
doc/development/project_management.md

16-16: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


36-36: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


23-23: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


29-29: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

🔇 Additional comments (4)
.github/ISSUE_TEMPLATE/FEATURE.yml (2)

47-48: LGTM! Clear section organization.

The introduction of separate sections for Group Labels and Project Board Labels provides good structural clarity.


Line range hint 1-61: Verify removal of old priority labels.

Let's ensure all old priority labels (p1-p4) are removed from the repository.

✅ Verification successful

Old priority labels (p1-p4) have been successfully removed

Based on the comprehensive check of all YAML files in the repository, particularly the issue templates in the .github directory, there are no references to the old priority labels (p1-p4). The priority system has been properly updated to use the new project board labels (Urgent, High, Medium, Low) as intended.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for any remaining references to old priority labels
echo "Checking for old priority label references..."
rg -i "priority.*p[1-4]" --type yaml
rg -i "p[1-4].*priority" --type yaml

Length of output: 178


Script:

#!/bin/bash
# Let's check for any label-related files and their content
echo "Checking for label configurations..."
fd -e yml -e yaml | xargs cat

# Also check for any references to priority in yaml files
echo -e "\nChecking for priority-related content..."
rg -i "priority" --type yaml

Length of output: 7505


Script:

#!/bin/bash
# Let's check specifically in the .github directory for label configurations
echo "Checking .github directory for label configurations..."
fd . .github -t f -e yml -e yaml | xargs cat

# Also check for any existing labels file
echo -e "\nChecking for labels.yml or similar files..."
fd labels -t f -e yml -e yaml | xargs cat || true

Length of output: 18952

.github/ISSUE_TEMPLATE/ISSUE.yml (1)

63-67: Clarify integration with project board priorities

While the priority levels are well-defined, there should be explicit guidance on how these labels map to project board priorities to avoid confusion and ensure consistent usage.

Let's verify if there are any existing priority-related configurations:

.github/ISSUE_TEMPLATE/BUG.yml (1)

62-76: Verify the implementation of project board priorities

The PR objectives mention moving priority planning to the project board, but the template doesn't provide instructions on how to set these values in the project board UI.

.github/ISSUE_TEMPLATE/FEATURE.yml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/BUG.yml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/BUG.yml Show resolved Hide resolved
@SirMDA SirMDA self-assigned this Nov 23, 2024
@SirMDA SirMDA requested review from Zelberor and asamluka November 23, 2024 15:16
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
doc/development/project_management.md (2)

16-18: Minor grammatical improvements needed

For better readability, consider adding a comma after "issue" in the first sentence.

-After creating the issue it has to be added to the project board.
+After creating the issue, it has to be added to the project board.

16-37: Well-structured documentation for the new project management approach

The documentation effectively captures the transition from labels to project board-based priority management. The priority and size categories are well-defined with clear criteria and time estimates, making it easier for team members to categorize issues consistently.

Consider adding a brief example of how to set these fields on the project board to make the documentation more actionable.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~19-~19: Possible missing comma found.
Context: ...For tracking time and complexity of the issue we will use the predefined Priority a...

(AI_HYDRA_LEO_MISSING_COMMA)


[grammar] ~22-~22: The article ‘the’ may be missing.
Context: ...AF Project Backlog Board. Priority has following states: - Urgent: Critical bug causing syst...

(HAVE_FOLLOWING_NN)


[uncategorized] ~24-~24: Loose punctuation mark.
Context: ...iority has following states: - Urgent: Critical bug causing system crash, need...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...tem crash, needs immediate fix. - High: Major feature request or significant bu...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~26-~26: Loose punctuation mark.
Context: ...ant bug affecting many users. - Medium: Minor feature request or bug with a wor...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~27-~27: Loose punctuation mark.
Context: ...equest or bug with a workaround. - Low: Cosmetic changes or minor improvements....

(UNLIKELY_OPENING_PUNCTUATION)


[grammar] ~29-~29: The article ‘the’ may be missing.
Context: ...hanges or minor improvements. Size has following states: - Tiny: Small typo fix or minor cod...

(HAVE_FOLLOWING_NN)


[uncategorized] ~31-~31: Loose punctuation mark.
Context: ...s. Size has following states: - Tiny: Small typo fix or minor code refactor. ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~32-~32: Loose punctuation mark.
Context: ...r. Estimated time: 30 minutes. - Small: Simple bug fix or small feature additio...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~32-~32: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...small feature addition. Estimated time: 1-2 hours. - Medium: Moderate feature add...

(HYPHEN_TO_EN)


[uncategorized] ~33-~33: Loose punctuation mark.
Context: ...n. Estimated time: 1-2 hours. - Medium: Moderate feature addition or multiple b...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~33-~33: If specifying a range, consider using an en dash instead of a hyphen.
Context: ... or multiple bug fixes. Estimated time: 1-2 days. - Large: Major feature implemen...

(HYPHEN_TO_EN)


[uncategorized] ~34-~34: Loose punctuation mark.
Context: ...xes. Estimated time: 1-2 days. - Large: Major feature implementation or signifi...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~34-~34: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...r significant refactor. Estimated time: 1-2 weeks. - X-Large: Large-scale feature...

(HYPHEN_TO_EN)


[uncategorized] ~35-~35: Loose punctuation mark.
Context: .... Estimated time: 1-2 weeks. - X-Large: Large-scale feature or complete module ...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~35-~35: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...mplete module overhaul. Estimated time: 2-4 weeks. Especially EPIC issues should ...

(HYPHEN_TO_EN)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9c40f31 and bf594ee.

📒 Files selected for processing (1)
  • doc/development/project_management.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
doc/development/project_management.md

[uncategorized] ~19-~19: Possible missing comma found.
Context: ...For tracking time and complexity of the issue we will use the predefined Priority a...

(AI_HYDRA_LEO_MISSING_COMMA)


[grammar] ~22-~22: The article ‘the’ may be missing.
Context: ...AF Project Backlog Board. Priority has following states: - Urgent: Critical bug causing syst...

(HAVE_FOLLOWING_NN)


[uncategorized] ~24-~24: Loose punctuation mark.
Context: ...iority has following states: - Urgent: Critical bug causing system crash, need...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...tem crash, needs immediate fix. - High: Major feature request or significant bu...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~26-~26: Loose punctuation mark.
Context: ...ant bug affecting many users. - Medium: Minor feature request or bug with a wor...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~27-~27: Loose punctuation mark.
Context: ...equest or bug with a workaround. - Low: Cosmetic changes or minor improvements....

(UNLIKELY_OPENING_PUNCTUATION)


[grammar] ~29-~29: The article ‘the’ may be missing.
Context: ...hanges or minor improvements. Size has following states: - Tiny: Small typo fix or minor cod...

(HAVE_FOLLOWING_NN)


[uncategorized] ~31-~31: Loose punctuation mark.
Context: ...s. Size has following states: - Tiny: Small typo fix or minor code refactor. ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~32-~32: Loose punctuation mark.
Context: ...r. Estimated time: 30 minutes. - Small: Simple bug fix or small feature additio...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~32-~32: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...small feature addition. Estimated time: 1-2 hours. - Medium: Moderate feature add...

(HYPHEN_TO_EN)


[uncategorized] ~33-~33: Loose punctuation mark.
Context: ...n. Estimated time: 1-2 hours. - Medium: Moderate feature addition or multiple b...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~33-~33: If specifying a range, consider using an en dash instead of a hyphen.
Context: ... or multiple bug fixes. Estimated time: 1-2 days. - Large: Major feature implemen...

(HYPHEN_TO_EN)


[uncategorized] ~34-~34: Loose punctuation mark.
Context: ...xes. Estimated time: 1-2 days. - Large: Major feature implementation or signifi...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~34-~34: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...r significant refactor. Estimated time: 1-2 weeks. - X-Large: Large-scale feature...

(HYPHEN_TO_EN)


[uncategorized] ~35-~35: Loose punctuation mark.
Context: .... Estimated time: 1-2 weeks. - X-Large: Large-scale feature or complete module ...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~35-~35: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...mplete module overhaul. Estimated time: 2-4 weeks. Especially EPIC issues should ...

(HYPHEN_TO_EN)

🔇 Additional comments (2)
doc/development/project_management.md (2)

19-28: Verify priority states and improve grammar

The priority states are well-defined, but there are two minor improvements needed:

  1. Add "the" before "following states"
  2. Ensure these states exactly match the project board configuration
-Priority has following states:
+Priority has the following states:
🧰 Tools
🪛 LanguageTool

[uncategorized] ~19-~19: Possible missing comma found.
Context: ...For tracking time and complexity of the issue we will use the predefined Priority a...

(AI_HYDRA_LEO_MISSING_COMMA)


[grammar] ~22-~22: The article ‘the’ may be missing.
Context: ...AF Project Backlog Board. Priority has following states: - Urgent: Critical bug causing syst...

(HAVE_FOLLOWING_NN)


[uncategorized] ~24-~24: Loose punctuation mark.
Context: ...iority has following states: - Urgent: Critical bug causing system crash, need...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...tem crash, needs immediate fix. - High: Major feature request or significant bu...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~26-~26: Loose punctuation mark.
Context: ...ant bug affecting many users. - Medium: Minor feature request or bug with a wor...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~27-~27: Loose punctuation mark.
Context: ...equest or bug with a workaround. - Low: Cosmetic changes or minor improvements....

(UNLIKELY_OPENING_PUNCTUATION)


29-37: Standardize time formats and verify size categories

The size categories are well-defined, but consider these improvements:

  1. Add "the" before "following states"
  2. Use consistent time format (either hours or days for medium size)
  3. Use en dashes (–) instead of hyphens (-) for time ranges
  4. Verify these match the project board configuration
-Size has following states:
+Size has the following states:

-Estimated time: 1-2 hours
+Estimated time: 1–2 hours

-Estimated time: 1-2 days
+Estimated time: 8–16 hours

-Estimated time: 1-2 weeks
+Estimated time: 1–2 weeks

-Estimated time: 2-4 weeks
+Estimated time: 2–4 weeks
🧰 Tools
🪛 LanguageTool

[grammar] ~29-~29: The article ‘the’ may be missing.
Context: ...hanges or minor improvements. Size has following states: - Tiny: Small typo fix or minor cod...

(HAVE_FOLLOWING_NN)


[uncategorized] ~31-~31: Loose punctuation mark.
Context: ...s. Size has following states: - Tiny: Small typo fix or minor code refactor. ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~32-~32: Loose punctuation mark.
Context: ...r. Estimated time: 30 minutes. - Small: Simple bug fix or small feature additio...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~32-~32: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...small feature addition. Estimated time: 1-2 hours. - Medium: Moderate feature add...

(HYPHEN_TO_EN)


[uncategorized] ~33-~33: Loose punctuation mark.
Context: ...n. Estimated time: 1-2 hours. - Medium: Moderate feature addition or multiple b...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~33-~33: If specifying a range, consider using an en dash instead of a hyphen.
Context: ... or multiple bug fixes. Estimated time: 1-2 days. - Large: Major feature implemen...

(HYPHEN_TO_EN)


[uncategorized] ~34-~34: Loose punctuation mark.
Context: ...xes. Estimated time: 1-2 days. - Large: Major feature implementation or signifi...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~34-~34: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...r significant refactor. Estimated time: 1-2 weeks. - X-Large: Large-scale feature...

(HYPHEN_TO_EN)


[uncategorized] ~35-~35: Loose punctuation mark.
Context: .... Estimated time: 1-2 weeks. - X-Large: Large-scale feature or complete module ...

(UNLIKELY_OPENING_PUNCTUATION)


[typographical] ~35-~35: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...mplete module overhaul. Estimated time: 2-4 weeks. Especially EPIC issues should ...

(HYPHEN_TO_EN)

Copy link
Collaborator

@asamluka asamluka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good improvement of the templates with visualization of the priority and issue size, so that it is easier to determine them.

@asamluka asamluka merged commit dc831f6 into main Nov 24, 2024
4 checks passed
@asamluka asamluka deleted the 518-feature-move-priority-planning-from-labels-to-the-project-board branch November 24, 2024 09:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature]: Move priority planning from labels to the project board
2 participants