WEB-548: Add comprehensive 7-step contribution workflow

[shubhamkumar9199]

This pr add comprehensive 7-step contribution workflow

WEB-548

Checklist

Please make sure these boxes are checked before submitting your pull request - thanks!

• If you have multiple commits please combine them into one commit by squashing them.

• Read and understood the contribution guidelines at web-app/.github/CONTRIBUTING.md.

Summary by CodeRabbit

• Documentation
  • Updated contributing guide with a structured 7-step contribution workflow
  • Added comprehensive guidance on branching, UI/UX standards, code formatting, and commit best practices
  • Expanded PR checklist and contributor resources

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Note

.coderabbit.yaml has unrecognized properties

CodeRabbit is using all valid settings from your configuration. Unrecognized properties (listed below) have been ignored and may indicate typos or deprecated fields that can be removed.

⚠️ Parsing warnings (1)

Validation error: Unrecognized key(s) in object: 'pre_merge_checks'

⚙️ Configuration instructions

• Please see the configuration documentation for more information.
• You can also validate your configuration using the online YAML validator.
• 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

Walkthrough

The CONTRIBUTING.md file was restructured and significantly expanded from a basic Getting Started guide to a comprehensive 7-step contribution workflow. Changes include new sections on discussion protocols, Jira issue tracking, branching conventions, UI/UX standards, code formatting, commit practices, and PR checklists, replacing the prior lightweight onboarding approach with detailed contributor guidance.

Changes

Cohort / File(s)

Change Summary

Documentation Update CONTRIBUTING.md

Replaced compact Getting Started section with structured 7-step contribution workflow; added sections for discussion, Jira tracking, branching, UI/UX standards, formatting guidelines, commit hygiene, PR checklist, and help resources; introduced detailed visual guidelines, typography, grid spacing, Angular Material usage, and git workflow examples; reorganized and expanded prior scattered tips into cohesive contributor handbook.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Suggested reviewers

• IOhacker

Pre-merge checks

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title accurately summarizes the main change: adding a comprehensive 7-step contribution workflow to the CONTRIBUTING.md file, which aligns with the primary objective of the changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (5)

CONTRIBUTING.md (5)

13-13: Prefer "take a look" for American English consistency.

Line 13 uses "Have a look" when "take a look" is the more common form in American English.

🔎 Suggested fix

- Have a look at our [Wiki](https://github.com/openMF/web-app/wiki).
+ Take a look at our [Wiki](https://github.com/openMF/web-app/wiki).

---

64-72: Clarify the branching policy regarding the main branch.

Step 3 directs contributors to "never branch from master or main" (line 68), but the later "Git and Github" section (line 165) describes the main branch as the release/hotfix branch. The policy is sound—contributors shouldn't branch from main—but the reasoning isn't clear in Step 3. Consider explicitly noting that main is reserved for releases and hotfixes, not for regular development work.

🔎 Suggested clarification

 ## Step 3: Branching Strategy
 
 We follow a strict branching model to keep our history clean.
 
-- **Upstream Branch:** Always branch from `dev`. Never branch from `master` or `main`.
+- **Upstream Branch:** Always branch from `dev`. Never branch from `master` or `main` (which are reserved for releases and hotfixes only).

Also applies to: 165-165

---

75-89: Add a link to the Figma design system.

Step 4 references "the Figma mockup" (line 81) as the source of truth for visual design, but doesn't provide a link. Consider adding a link to the team's Figma design file or project for easier reference.

---

152-152: Correct GitHub capitalization.

The official name of the platform is "GitHub" (capital G and H), not "Github".

🔎 Suggested fix

- ## Git and Github
+ ## Git and GitHub

---

154-215: Consider extracting detailed Git workflow to a separate document to reduce redundancy.

The "Git and Github" section (lines 154–300) substantially overlaps with Steps 3 and 6 of the main workflow (branching and commit hygiene). Both explain branch naming, squashing, and rebasing. While the detailed git section is helpful for less experienced contributors, the duplication may confuse users about which guidance to follow.

Recommended approach: Extract the detailed Git workflow into a separate file (e.g., DEVELOPMENT.md or .github/GIT_WORKFLOW.md) and reference it from the 7-step workflow for contributors who want deeper guidance.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cad6200 and a3a7462.

📒 Files selected for processing (1)

• CONTRIBUTING.md

🧰 Additional context used

🪛 LanguageTool

CONTRIBUTING.md

[locale-violation] ~13-~13: In American English, “take a look” is more commonly used.
Context: ...w+Contributor+Getting+Started+Guide). - Have a look at our [Wiki](https://github.com/openMF...

(HAVE_A_LOOK)

---

[uncategorized] ~152-~152: The official name of this software platform is spelled with a capital “H”.
Context: ...derstand our commit message conventions. ## Git and Github ...

(GITHUB)

🔇 Additional comments (1)

CONTRIBUTING.md (1)

296-298: Verify whether Travis CI is still in use; the reference may be outdated.

The "Skipping a Travis CI Build" section references Travis CI, which was a common CI/CD service but many projects have migrated to GitHub Actions. Confirm whether this project still uses Travis CI or if this section should reference GitHub Actions instead.

[IOhacker]

@DavidH-1 we would like to know your opinion about this change.

[IOhacker]

LGTM

[DavidH-1]

Looks good update. Thanks for this