Skip to content

docs: add CONTRIBUTING.md and seed CHANGELOG.md - #29

Merged
subhampatel1108 merged 5 commits into
mainfrom
docs/contributing-changelog
Apr 21, 2026
Merged

docs: add CONTRIBUTING.md and seed CHANGELOG.md#29
subhampatel1108 merged 5 commits into
mainfrom
docs/contributing-changelog

Conversation

@jagguji

@jagguji jagguji commented Apr 20, 2026

Copy link
Copy Markdown
Collaborator

Summary

Closes #22 and #24. Based on ci/repo-infrastructure.

  • CONTRIBUTING.md — setup, .env format, npm run generate, 3-retry feedback loop, .failed.res handling, manual sync workflow, and the "don't merge prerelease sync PRs" rule
  • CHANGELOG.md — seeded in Keep-a-Changelog format; Unreleased section captures every PR in this cleanup wave

Skipped

Test plan

  • Markdown renders cleanly on GitHub
  • Keep the Unreleased section updated as further PRs land

🤖 Generated with Claude Code

jagguji and others added 5 commits April 20, 2026 18:46
- Set package.json license to MIT to match LICENSE file (closes #6)
- Drop stale main: index.js entry pointing at a missing file (closes #8)
- Remove three debug console.log lines that leaked TEST_KEY to stdout (closes #7)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…list

- Delete committed juspay-rescript-blend-0.1.0.tgz and add *.tgz to .gitignore (closes #9)
- Rewrite .gitignore: drop stray '/' and duplicate .env entries; note intentional src/*.js commit (closes #10, #12)
- Move dotenv from dependencies to devDependencies (closes #11)
- Add files allowlist to replace .npmignore reliance (closes #14)
- Fill in author/repository/bugs/homepage metadata (closes #15)
- Declare engines.node >=20 and seed .nvmrc (closes #16)

Verified npm pack ships 126 files, no scripts/ or artifacts.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Four workflows (closes #17):

- ci.yml — rescript build on push/PR to main; fails if any src/*.failed.res exists
- pkg-pr-new.yml — publishes per-PR preview via pkg.pr.new on push/PR to main
- publish-npm.yml — publishes to NPM on GitHub Release; workflow_dispatch supports dry-run; enforces tag matches package.json version
- sync-bindings.yml — manual-only regeneration against @juspay/blend-design-system; refuses prerelease versions (-beta/-alpha/-rc) unless allow_prerelease=true is explicitly set

Pre-merge requirements (per issue #17):
- Install the pkg.pr.new GitHub App on juspay/blend-rescript
- Add repo secret NPM_TOKEN
- Add repo secrets LITELLM_BASE_URL, LITELLM_API_KEY, TEST_KEY
- Create npm environment in repo settings

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- .github/CODEOWNERS → @Roshan84ya as default; update once team handles are
  confirmed (closes #18)
- .github/PULL_REQUEST_TEMPLATE.md with build/failed-check/version-bump
  checklist (closes #19)
- .github/ISSUE_TEMPLATE/binding-out-of-sync.md for reporting drifted bindings
  (closes #19)
- .github/ISSUE_TEMPLATE/bug_report.md for general bugs (closes #19)
- .github/dependabot.yml: weekly npm + github-actions, ignores
  @juspay/blend-design-system since sync is driven by the manual workflow
  (closes #20)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- CONTRIBUTING.md covers setup, .env format, npm run generate, the 3-retry
  feedback loop, .failed.res handling, the manual sync workflow, and the
  rule that prerelease blend versions must not be merged (closes #22)
- CHANGELOG.md seeded in Keep-a-Changelog format with the Unreleased entries
  covering the current cleanup wave (closes #24)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@subhampatel1108
subhampatel1108 merged commit 618577f into main Apr 21, 2026
2 of 3 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.

docs: add CONTRIBUTING.md

2 participants