Skip to content

docs: add CONTRIBUTING guide with first contribution section - #5

Merged
olitreadwell merged 1 commit into
mainfrom
docs/add-contributing-guide-v3
Aug 19, 2026
Merged

docs: add CONTRIBUTING guide with first contribution section#5
olitreadwell merged 1 commit into
mainfrom
docs/add-contributing-guide-v3

Conversation

@olitreadwell

Copy link
Copy Markdown
Owner

Upstream target

themesberg/flowbite-react — no issue; self-found gap. The PR template links to a CONTRIBUTING.md that does not exist.

What changed

Adds CONTRIBUTING.md mirroring 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 no CONTRIBUTING.md (verified: no file on main or develop; root listing has only README.md and readme-images). The content already exists as a website page, so this PR surfaces it as the file the template expects.

How to verify

  • After merge, https://github.com/olitreadwell/flowbite-react/blob/main/CONTRIBUTING.md#your-first-code-contribution resolves to the "Your First Code Contribution" section.
  • curl -s -o /dev/null -w '%{http_code}' https://raw.githubusercontent.com/olitreadwell/flowbite-react/main/CONTRIBUTING.md returns 200.
  • Every external link in the file returns 200 (checked with curl; the one dead link inherited from the website guide, github.com/GNOME/byzanz, is replaced with github.com/phw/peek).

Coverage

N/A — docs-only, no coverage tool applies.

Checks run locally

  • Content mirrors the repo's own apps/web/content/docs/getting-started/contributing.mdx (same sections, same commands, same links), with the stale "app folder" path corrected to apps/web.
  • Anchor verified: heading "Your First Code Contribution" generates #your-first-code-contribution, matching the template link.
  • All external links checked: 200 (byzanz replaced with peek; flowbite-react.com docs links are the same ones the website guide uses).
  • Tests / Lint / Typecheck / Build: N/A — no code changed.

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.md exists), 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):

gh pr create --repo themesberg/flowbite-react --base main --head olitreadwell:docs/add-contributing-guide-v3

Prerequisites: none. No CLA/DCO bot found in themesberg/flowbite-react; no signed-commit requirement found.

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).
@olitreadwell
olitreadwell merged commit f9f2e6c into main Aug 19, 2026
5 checks passed
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