FEATURE/HCMPRE-1111 : Sample Ticket for reference #2042
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
📝 WalkthroughWalkthroughThe pull request introduces modifications to the Changes
Possibly related PRs
Suggested reviewers
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (4)
README.md (4)
Line range hint
110-124: Consider adding environment variables section for implementation teamsThe original section includes detailed environment variables, but they're missing from the implementation teams' section. Consider either:
- Adding environment variables section for implementation teams, or
- Clarifying if they use the same variables
Line range hint
110-124: Add sample .env file reference for implementation teamsThe original section includes a link to a sample .env file, but it's missing from the implementation teams' section. Consider adding a similar reference to help users get started quickly.
Add .env file ```bash micro-ui/web/.env
--- Line range hint `1-124`: **Improve document structure and organization** Consider reorganizing the README to: 1. Move the new implementation section next to the original "Run Locally" section 2. Group related information together 3. Add a table of contents for better navigation This would make the document more cohesive and easier to follow. --- Based on the package.json files and README content, I can now provide a clear response about the different paths: **Clarify the implementation paths in the README** The `micro-ui/web/micro-ui-internals` is the core development path containing all source modules, libraries and components, while `micro-ui/web` is the main application that consumes these packages. Here's why: - `micro-ui/web/micro-ui-internals` contains the source code for all UI modules, libraries and components as workspaces - `micro-ui/web` is the main application that imports these modules as dependencies (see @egovernments/* dependencies) Recommend updating the README to clarify: - `micro-ui/web/micro-ui-internals` - Use this path for core development and contributing to the UI modules/components - `micro-ui/web` - Use this path for implementing applications that consume the DIGIT-UI modules <details> <summary>🔗 Analysis chain</summary> Line range hint `110-124`: **Clarify the differences between implementation paths** The README now shows two different paths for running the UI: 1. `micro-ui/web/micro-ui-internals` (original) 2. `micro-ui/web` (new implementation team path) This might confuse users about which path to follow. Please clarify: 1. When should each path be used? 2. What are the differences between these implementations? 3. Are there any specific considerations for each approach? Let's verify the directory structure and documentation consistency: --- Let me gather more information about the structure and purpose of these directories: </details> <details> <summary>🏁 Scripts executed</summary> The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Check if both directories exist and their structure fd -t d "micro-ui/web$" fd -t d "micro-ui/web/micro-ui-internals$" # Check for any additional documentation about these paths rg -A 3 "micro-ui/web" --type mdLength of output: 13692
Script:
#!/bin/bash # Check package.json files in both paths to understand their purposes echo "=== micro-ui/web/package.json ===" fd "package.json$" micro-ui/web -d 1 -x cat {} echo -e "\n=== micro-ui/web/micro-ui-internals/package.json ===" fd "package.json$" micro-ui/web/micro-ui-internals -d 1 -x cat {} # Check if there are any README files explaining the difference echo -e "\n=== Looking for implementation details in READMEs ===" rg -i "implement|internal|team" micro-ui/web/README.md || true rg -i "implement|internal|team" micro-ui/web/micro-ui-internals/README.md || trueLength of output: 6676
jagankumar-egov
changed the title
jagankumar-egov
added a commit
that referenced
this pull request
Dec 16, 2024
Sample Ticket for reference #2042
jagankumar-egov
added a commit
that referenced
this pull request
Dec 16, 2024
Sample Ticket for reference #2042
|
Refer this sample ticket format for any New PRS for Master, Develop & Console branches. @egovernments/core-ui-team |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Feature Request
JIRA ID
HCMPRE-1111
Module
Console/Microplan/Core/Product
Description
Description about the ticket
Related Issues
related issues or feature/ impact etc