docs: add CONTRIBUTING guide with first contribution section - #5
Merged
Conversation
The PR template links to CONTRIBUTING.md#your-first-code-contribution, but no CONTRIBUTING.md exists, so the link 404s. Add the repo's own contributing guide (apps/web/content/docs/getting-started/contributing.mdx, based on contributing-gen) as a standalone CONTRIBUTING.md, so the template anchor resolves and the file matches the website page. The byzanz link from the website guide is replaced with peek (byzanz is archived and 404s).
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
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.
CONTRIBUTING.md#your-first-code-contribution)Upstream target
themesberg/flowbite-react — no issue; self-found gap. The PR template links to a
CONTRIBUTING.mdthat does not exist.What changed
Adds
CONTRIBUTING.mdmirroring the repo's own contributing guide,apps/web/content/docs/getting-started/contributing.mdx(based on contributing-gen, the same template family as spicetify/cli), which already includes the "Your First Code Contribution" section the PR template links to. The standalone file makes the template anchor resolve and stays consistent with the website page.Why
The PR template's first checkbox links to
https://github.com/themesberg/flowbite-react/blob/main/CONTRIBUTING.md#your-first-code-contribution, which 404s: the repo has noCONTRIBUTING.md(verified: no file onmainordevelop; root listing has onlyREADME.mdandreadme-images). The content already exists as a website page, so this PR surfaces it as the file the template expects.How to verify
https://github.com/olitreadwell/flowbite-react/blob/main/CONTRIBUTING.md#your-first-code-contributionresolves to the "Your First Code Contribution" section.curl -s -o /dev/null -w '%{http_code}' https://raw.githubusercontent.com/olitreadwell/flowbite-react/main/CONTRIBUTING.mdreturns200.github.com/GNOME/byzanz, is replaced withgithub.com/phw/peek).Coverage
N/A — docs-only, no coverage tool applies.
Checks run locally
apps/web/content/docs/getting-started/contributing.mdx(same sections, same commands, same links), with the stale "app folder" path corrected toapps/web.#your-first-code-contribution, matching the template link.Style / template compliance
Follows the repo's PR template (checkbox above) and Conventional Commits commit style (
docs: ...). The guide is the repo's own contributing-gen-based content, not a new structure.Confidence: HIGH
Docs-only addition; content sourced from the repo's own guide, every link verified. Only residual risk: maintainers may prefer to keep the guide website-only.
AI assistance
Drafted with AI assistance. The gap was found and verified against the current repo (template link 404s, no
CONTRIBUTING.mdexists), the content is copied from the repo's own contributing page, every link was checked, and the diff was reviewed line by line before opening.Recommendation
Ready to send upstream as-is.
PROMOTION NOTE (remove this section before/when opening against upstream):
Prerequisites: none. No CLA/DCO bot found in
themesberg/flowbite-react; no signed-commit requirement found.