Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (31 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

43 lines (31 loc) · 1.06 KB
Raw

Contributing

Thanks for helping improve ChekIt.

Good Contributions

  • Fix unclear or incorrect ingredient descriptions.
  • Add well-known ingredient synonyms.
  • Improve matching behavior without adding private data or secrets.
  • Improve docs, local setup, and API examples.

Data Guidelines

  • Edit data/ingredients.json for public ingredient data changes.
  • Keep descriptions factual, plain-language, and useful to acne-prone skincare users.
  • Do not add medical diagnosis claims.
  • Do not add private customer data, staging data, API logs, user data, or secrets.
  • Include context in the pull request for data changes. If you used a source, name it.

Local Setup

Fork https://github.com/JoshAquila/chekit, then clone your fork:

git clone https://github.com/<your-username>/chekit.git
cd chekit

Then run:

npm install
npm run import-data
npm run smoke
npm run dev

Pull Requests

  • Keep PRs focused.
  • Explain what changed and why.
  • Run npm run smoke before opening a PR.
  • Maintainers may edit wording for clarity, safety, or consistency.