docs: make CONTRIBUTING.md beginner-friendly - #7549
Open
deepshekhardas wants to merge 1 commit into
Open
Conversation
Expand root CONTRIBUTING.md from a single link into a quick-start for first-time contributors: fork/clone, pnpm install, dev watch, tests, lint/format, changeset, conventional commit and PR. Complements docs site guide and addresses refinedev#7516.
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Complements #7539 (which updates the docs site) by making the repo-root CONTRIBUTING.md beginner-friendly.
Previously the file was a single line linking to https://refine.dev/docs/contributing/. First-time contributors landing via GitHub's Contributing link saw no steps. This adds a 7-step quick start: fork/clone + upstream, pnpm install, pnpm dev --scope, tests, lint/format (Biome), changeset, conventional commit & PR. Keeps the full guide linked.
Related to #7516.