Skip to content

docs: add LICENSE, README, CHANGELOG/CONTRIBUTING and validate CI#1

Merged
CreatmanCEO merged 1 commit into
mainfrom
polish-readme-and-meta
May 6, 2026
Merged

docs: add LICENSE, README, CHANGELOG/CONTRIBUTING and validate CI#1
CreatmanCEO merged 1 commit into
mainfrom
polish-readme-and-meta

Conversation

@CreatmanCEO
Copy link
Copy Markdown
Owner

Summary

Wave-2 polish for B-tier ecosystem repos. The repo had no README and no LICENSE — both added. No source code touched.

  • LICENSE — MIT (was missing)
  • README.md (was missing): badges row, why/how, tech stack table, configuration, limitations, Related Claude Code ecosystem block, expanded author block
  • CHANGELOG.md reconstructed from git log (Keep a Changelog)
  • CONTRIBUTING.md with priority list and PR checklist
  • .github/workflows/validate.yml — package.json validation, JS syntax check on src/ and test/, meta-files presence, README section checks

Security note for reviewer

The README explicitly flags that BOT_TOKEN, CHAT_ID, and ALLOWED_ORIGIN are currently hardcoded in src/index.js and recommends moving them to Wrangler secrets. Per polish scope, source code was not modified — this is a follow-up for Nick.

Test plan

  • CI green on this PR
  • README renders correctly on github.com
  • All ecosystem links resolve

Notes

  • No source code or config changes
  • No file deletions

Wave-2 polish for B-tier repos:
- LICENSE — MIT (was missing)
- README.md (was missing): badges row, why/how, tech stack table,
  configuration, limitations, Related Claude Code ecosystem block,
  expanded author block. Flags that BOT_TOKEN should move to Wrangler
  secrets.
- CHANGELOG.md reconstructed from git history (Keep a Changelog)
- CONTRIBUTING.md with priority list and PR checklist
- .github/workflows/validate.yml: package.json validity, JS syntax
  check on src/ and test/, meta-files presence, README sections

No source code changes.
@CreatmanCEO CreatmanCEO merged commit 174512e into main May 6, 2026
1 check passed
@CreatmanCEO CreatmanCEO deleted the polish-readme-and-meta branch May 6, 2026 14:44
CreatmanCEO added a commit that referenced this pull request May 6, 2026
…crets (#2)

⚠️ The previous src/index.js shipped a real Telegram bot token, chat id,
and production origin in the source. The token was publicly leaked in
this repo from 2026-02-10 (GitHub secret-scanning alert #1, never
resolved).

Changes:
- src/index.js — read BOT_TOKEN, CHAT_ID, ALLOWED_ORIGIN from env (Wrangler
  bindings), return 500 with a clear setup message if any is missing.
  No hardcoded values remain.
- .env.example — document the required secrets and how to set them via
  `wrangler secret put`. The file contains placeholder values only.

Note: this commit does NOT remove the leaked token from git history.
The token must be revoked via @Botfather as a separate operational step
(rotation, then `wrangler secret put BOT_TOKEN <new-token>`). After
revoke, the GitHub secret-scanning alert can be closed as "revoked":
https://github.com/CreatmanCEO/telegram-form-worker/security/secret-scanning/1

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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