MXWAR-86: Improve onboarding and first-use contributor workflow documentation#119
MXWAR-86: Improve onboarding and first-use contributor workflow documentation#119AshutoshSingh058 wants to merge 1 commit into
Conversation
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds DEVELOPER_ONBOARDING_GUIDE.md: a 109-line contributor onboarding guide describing repo navigation, frontend architecture (React/TypeScript/Vite + OpenAPI Axios client), src/ layout, state/styling conventions, page-creation workflow, and debugging steps. ChangesDeveloper Onboarding Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@DEVELOPER_ONBOARDING_GUIDE.md`:
- Line 7: Update the sentence that mentions the default testing credentials (the
example "mifos"/"password") to explicitly state these credentials are for
local/demo environments only and must never be used in shared, staging, or
production environments; add a clear warning sentence or callout immediately
after the existing line that directs contributors to use real credentials or
environment-specific secrets in non-local environments and to rotate/remove the
test account before any shared deployment.
- Line 48: Update the wording that describes src/components/ui/ in
DEVELOPER_ONBOARDING_GUIDE.md to avoid calling ShadCN “unstyled”: replace the
phrase "Primitive, unstyled components generated by ShadCN" with something like
"Pre-styled ShadCN components (Tailwind defaults) — customize/wrap instead of
editing freely" so it accurately reflects that shadcn/ui provides
Tailwind-default styled components intended for in-repo customization (unstyled
primitives come from Radix/Base UI).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: d7e7eb42-e759-40ca-8db1-07a3b9baf859
📒 Files selected for processing (1)
DEVELOPER_ONBOARDING_GUIDE.md
|
|
||
| ## 🚀 First-Time Exploration Workflow | ||
|
|
||
| The best way to understand the architecture is to use the app! After logging in with the default testing credentials (e.g., `mifos`/`password`), contributors can follow this workflow to build a fast mental model of how the major components connect: |
There was a problem hiding this comment.
Scope default credentials to local/demo environments only.
Please explicitly state these credentials are for local/demo setups only and must never be used in shared/staging/production environments.
Suggested doc tweak
-The best way to understand the architecture is to use the app! After logging in with the default testing credentials (e.g., `mifos`/`password`), contributors can follow this workflow to build a fast mental model of how the major components connect:
+The best way to understand the architecture is to use the app! For local/demo environments only, after logging in with default testing credentials (e.g., `mifos`/`password`), contributors can follow this workflow to build a fast mental model of how the major components connect. Never use default credentials in shared/staging/production environments.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@DEVELOPER_ONBOARDING_GUIDE.md` at line 7, Update the sentence that mentions
the default testing credentials (the example "mifos"/"password") to explicitly
state these credentials are for local/demo environments only and must never be
used in shared, staging, or production environments; add a clear warning
sentence or callout immediately after the existing line that directs
contributors to use real credentials or environment-specific secrets in
non-local environments and to rotate/remove the test account before any shared
deployment.
AshutoshSingh058
force-pushed
the
MXWAR-86-onboarding-docs
branch
from
5b3b802 to
4922685
Compare
2 participants
Description
This PR improves onboarding and first-use contributor documentation for the React Web App.
The changes introduce:
The goal is to reduce onboarding friction and help contributors better understand the application structure, workflows, and development flow during initial setup and exploration.
Related issues and discussion
MXWAR-86
Screenshots, if any
New Contributor Onboarding Workflow Guide
Added a dedicated onboarding and first-use exploration guide to help contributors understand the application flow, entity lifecycle, and migration-related expectations during initial setup.
Documentation-only change.
Checklist
If you have multiple commits please combine them into one commit by squashing them.
Read and understood the contribution guidelines at
CONTRIBUTING.md.Summary by CodeRabbit