Desired outcome
The repo has a CONTRIBUTING.md and GitHub issue and pull request templates.
Why it matters
This repo carries good first issue labelled issues, which invites outside contributors, but there is no .github/ directory at all and no CONTRIBUTING.md at the root. A new contributor has to reverse-engineer everything from package.json: which Node version (engines says >= 20), how to install, that npm run dev is the dev server, that npm run lint exists, that Prettier with prettier-plugin-tailwindcss is configured in .prettierrc.json and must be run before committing, and which env vars from .env.example are needed to boot the app.
The sibling repo SignalizeAI/SignalizeAI already has a CONTRIBUTING.md and a CODE_OF_CONDUCT.md that can be adapted rather than written from scratch.
Steps
- Add
CONTRIBUTING.md covering: prerequisites (Node >= 20), npm install, copying .env.example to .env.local, npm run dev, npm run lint, running Prettier, and the branch and commit conventions.
- Add
.github/ISSUE_TEMPLATE/bug_report.md and feature_request.md, plus .github/PULL_REQUEST_TEMPLATE.md.
- Link
CONTRIBUTING.md from README.md.
Documentation only, no code changes.
Claiming this
Comment below to claim it. A reply usually comes within a day.
Desired outcome
The repo has a
CONTRIBUTING.mdand GitHub issue and pull request templates.Why it matters
This repo carries
good first issuelabelled issues, which invites outside contributors, but there is no.github/directory at all and noCONTRIBUTING.mdat the root. A new contributor has to reverse-engineer everything frompackage.json: which Node version (enginessays >= 20), how to install, thatnpm run devis the dev server, thatnpm run lintexists, that Prettier withprettier-plugin-tailwindcssis configured in.prettierrc.jsonand must be run before committing, and which env vars from.env.exampleare needed to boot the app.The sibling repo
SignalizeAI/SignalizeAIalready has aCONTRIBUTING.mdand aCODE_OF_CONDUCT.mdthat can be adapted rather than written from scratch.Steps
CONTRIBUTING.mdcovering: prerequisites (Node >= 20),npm install, copying.env.exampleto.env.local,npm run dev,npm run lint, running Prettier, and the branch and commit conventions..github/ISSUE_TEMPLATE/bug_report.mdandfeature_request.md, plus.github/PULL_REQUEST_TEMPLATE.md.CONTRIBUTING.mdfromREADME.md.Documentation only, no code changes.
Claiming this
Comment below to claim it. A reply usually comes within a day.