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

[Feat] Memo type for issue types enum #8767

Merged
merged 3 commits into from
Feb 8, 2025
Merged

Conversation

GloireMutaliko21
Copy link
Contributor

@GloireMutaliko21 GloireMutaliko21 commented Feb 8, 2025

PR

Please note: we will close your PR without comment if you do not check the boxes above and provide ALL requested information.


Summary by CodeRabbit

  • New Features
    • Introduced a new “Memo” task type, enabling users to categorize tasks as short notes for documenting ideas, discussions, or important details.
    • The “Memo” type offers a distinct visual presentation with a unique icon and color, enhancing overall task management and clarity.

@GloireMutaliko21 GloireMutaliko21 self-assigned this Feb 8, 2025
Copy link
Contributor

coderabbitai bot commented Feb 8, 2025

Warning

Rate limit exceeded

@GloireMutaliko21 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 49 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 1288df3 and d4b08a4.

⛔ Files ignored due to path filters (1)
  • apps/api/src/assets/seed/ever-icons/task-issue-types/memo.svg is excluded by !**/*.svg
📒 Files selected for processing (1)
  • packages/core/src/lib/tasks/issue-type/default-global-issue-types.ts (1 hunks)

Walkthrough

This pull request introduces a new task type by adding the value MEMO to the TaskTypeEnum in the contracts module. It also updates the default global issue types in the core module to include the Memo type with its associated properties such as name, description, icon, color, and system/default flags. A minor formatting adjustment is made in the enum declaration to ensure consistency.

Changes

File(s) Change Summary
packages/contracts/.../issue-type.model.ts
packages/core/.../default-global-issue-types.ts
Added the new MEMO task type: updated the TaskTypeEnum and integrated a Memo entry into the default global issue types with proper attributes (name, description, icon, color, isSystem, and isDefault). A formatting comma was also added for consistency.

Possibly related PRs

Suggested reviewers

  • rahul-rocket

Poem

I'm just a bunny in the code maze,
Hopping over lines in a whimsical daze.
MEMO now adorns our enum's ground,
In every burrow, its charm is found.
Leaping with joy, I spread the cheer—code carrots are here!


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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: 1

🧹 Nitpick comments (2)
packages/core/src/lib/tasks/issue-type/default-global-issue-types.ts (2)

38-39: Consider using unique icon/color for MEMO type.

The MEMO type currently shares the same icon ('task-issue-types/category.svg') and color ('#8154BA') as the EPIC type. This might make it difficult for users to distinguish between these different issue types in the UI.

Consider creating a unique icon and color scheme for the MEMO type to improve visual distinction. For example:

-		icon: 'task-issue-types/category.svg',
-		color: '#8154BA',
+		icon: 'task-issue-types/memo.svg',
+		color: '#BA7D54',

33-42: Consider placement in the issue types array.

The MEMO type is currently placed before the EPIC type in the array. If the order of these types affects the UI presentation, consider moving MEMO to a more appropriate position in the hierarchy.

Consider moving the MEMO type after the EPIC type or to a position that better reflects its relative importance in the issue type hierarchy.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 28011f1 and 1288df3.

📒 Files selected for processing (2)
  • packages/contracts/src/lib/issue-type.model.ts (1 hunks)
  • packages/core/src/lib/tasks/issue-type/default-global-issue-types.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: build
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: test
🔇 Additional comments (1)
packages/contracts/src/lib/issue-type.model.ts (1)

35-36: LGTM! Clean addition of the MEMO task type.

The new MEMO type follows the existing enum pattern and maintains consistent formatting.

Copy link

nx-cloud bot commented Feb 8, 2025

View your CI Pipeline Execution ↗ for commit d4b08a4.

Command Status Duration Result
nx build gauzy -c=production --prod --verbose ✅ Succeeded 4m 29s View ↗
nx build desktop --base-href ./ ✅ Succeeded 1m 42s View ↗
nx build desktop-api --output-path=dist/apps/de... ✅ Succeeded 27s View ↗
nx run api:desktop-api ✅ Succeeded 1m 16s View ↗
nx build desktop-ui-lib --configuration=develop... ✅ Succeeded 33s View ↗
nx run gauzy:desktop-ui --base-href ./ ✅ Succeeded 3m 51s View ↗
nx build plugin-integration-wakatime ✅ Succeeded <1s View ↗
nx build desktop-lib ✅ Succeeded <1s View ↗
Additional runs (56) ✅ Succeeded ... View ↗

☁️ Nx Cloud last updated this comment at 2025-02-08 11:34:22 UTC

@evereq evereq merged commit add4aa8 into develop Feb 8, 2025
16 checks passed
@evereq evereq deleted the feat/issue-type-memo-type branch February 8, 2025 11:32
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.

2 participants