Skip to content

docs: add contributor guide for Rush monorepo development - #2199

Merged
AJIXuMuK merged 2 commits into
v4-devfrom
user/aterentiev/contributor-quick-start
Nov 16, 2026
Merged

AJIXuMuK merged 2 commits into
v4-devfrom
user/aterentiev/contributor-quick-start

Conversation

@AJIXuMuK

@AJIXuMuK AJIXuMuK commented Nov 16, 2026 •

Copy link
Copy Markdown
Collaborator
Q A
Bug fix? [ ]
New feature? [ ]
New sample? [ ]
Related issues? N/A

What's in this Pull Request?

Expand the existing Rush guide into a step-by-step contributor workflow for the monorepo:

  • Explain the repository layout, Rush versus Heft, and local workspace dependencies.
  • Document prerequisites, first-time installation, builds, tests, and dependency updates without requiring globally installed tools.
  • Cover certificate trust, tenant configuration, modern SharePoint page debugging, and the library edit/build/run loop.
  • Add documentation preview, change-file, and troubleshooting guidance.
  • Link the guide from the root README, test app README, contributor guides, and MkDocs navigation; correct outdated fast-serve instructions.
  • Present Rush and Heft as the standard contributor workflow, without version-specific branch framing.

Documentation-only changes. git diff --check passed for both commits; the initial local Node link check passed for nine added Markdown links and the guide's navigation entry. Application builds/tests and MkDocs preview were not run. The pre-commit hook could not run because its generated Husky bootstrap file is missing; it was bypassed for these documentation-only commits without changing hook configuration.

Guidance

  • You can delete this section when you are submitting the pull request.
  • Please update this PR information accordingly. We'll use this as part of our release notes in monthly communications.
  • Please target your PR to dev branch.

@AJIXuMuK
AJIXuMuK merged commit 6903ff3 into v4-dev Nov 16, 2026
2 checks passed
@AJIXuMuK
AJIXuMuK deleted the user/aterentiev/contributor-quick-start branch November 16, 2026 20:48
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.

1 participant