docs: add CONTRIBUTING guide with first contribution section - #4
Merged
Conversation
The PR template links to CONTRIBUTING.md#your-first-code-contribution, but no CONTRIBUTING.md exists, so the link 404s. Add the common contributing-generator template (as used by spicetify/cli and others) with a 'Your First Code Contribution' section matching the template anchor, adapted to this repo's bun/turbo/changesets conventions.
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.
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.mdbased on the common contributing-generator template (the same structure used by spicetify/cli, andrewyng/aisuite, and others), which includes the "Your First Code Contribution" section the PR template links to. Adapted to this repo's actual conventions: bun, turbo, Changesets,apps/webdocs workspace, and Conventional Commits.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 maintainers clearly intended one to exist.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.Coverage
N/A — docs-only, no coverage tool applies.
Checks run locally
package.jsonscripts (bun install/dev/test/lint/typecheck/format:check,changeset add/version/release) and workspace layout (apps/web,packages/ui/src/components).#your-first-code-contribution, matching the template link..github/ISSUE_TEMPLATE(bug_report.md,feature_request.md).Style / template compliance
Follows the repo's PR template (checkbox above) and Conventional Commits commit style (
docs: ...). The guide is a copy of the widely used contributing-generator template (as in spicetify/cli), not an original structure, adapted to this repo's real tooling.Confidence: HIGH
Docs-only addition; every claim verified against the repo's actual files. Only residual risk: maintainers may prefer a different structure.
AI assistance
Drafted with AI assistance. The gap was found and verified against the current repo (template link 404s, no
CONTRIBUTING.mdexists), the guide is adapted from the common contributing-generator template used by popular repos, every command was checked against the repo's realpackage.jsonscripts, 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.