docs: add CONTRIBUTING.md guide for MMU-UI contributors#346
docs: add CONTRIBUTING.md guide for MMU-UI contributors#346Aarti-panchal01 wants to merge 1 commit into
Conversation
|
📝 WalkthroughWalkthroughAdds a CONTRIBUTING.md file documenting repository onboarding, contribution rules, branch and commit naming conventions, PR checklist, code standards using BehaviorSubject state management without NgRx, test instructions, and issue routing. ChangesContributor Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 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 |
|
Hi @drtechie, Added a CONTRIBUTING.md to help new contributors (especially C4GT DMP Noticed there was no contribution guide in the repo — new contributors were having to figure out the Husky/commitlint setup on their own. |
![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
🤖 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 `@CONTRIBUTING.md`:
- Around line 48-53: Update the fenced code block that contains the
commit-message example ("type(scope): description" / "Valid types: feat, fix,
..." / "Example: feat(vitals): add blood pressure validation") in
CONTRIBUTING.md to include a language identifier (e.g., add ```text instead of
``` ) so markdownlint MD040 passes; modify that specific fenced block only to
open with ```text and keep the existing content and closing fence unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| ``` | ||
| type(scope): description | ||
|
|
||
| Valid types: feat, fix, build, chore, ci, docs, perf, refactor, revert, style, test | ||
| Example: feat(vitals): add blood pressure validation | ||
| ``` |
There was a problem hiding this comment.
Add a language to the fenced code block to satisfy markdownlint (MD040).
The commit format block is missing a fence language, which will fail/trigger docs lint.
Proposed fix
-```
+```text
type(scope): description
Valid types: feat, fix, build, chore, ci, docs, perf, refactor, revert, style, test
Example: feat(vitals): add blood pressure validation</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 48-48: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 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 `@CONTRIBUTING.md` around lines 48 - 53, Update the fenced code block that
contains the commit-message example ("type(scope): description" / "Valid types:
feat, fix, ..." / "Example: feat(vitals): add blood pressure validation") in
CONTRIBUTING.md to include a language identifier (e.g., add ```text instead of
``` ) so markdownlint MD040 passes; modify that specific fenced block only to
open with ```text and keep the existing content and closing fence unchanged.
1 participant
📋 Description
Adds CONTRIBUTING.md to help new contributors get started with MMU-UI
quickly. No contribution guide existed in the repo.
Related to PSMRI/AMRIT#130 (C4GT DMP 2026)
✅ Type of Change
ℹ️ Additional Information
Covers:
Summary by CodeRabbit
Documentation