mirror of
https://github.com/juherr/kill-the-news.git
synced 2026-06-20 22:03:48 +00:00
Julien Herr
7f5b913576
Add a security policy with private reporting channels and project-specific scope, plus a contributor guide covering dev setup, testing, and commit conventions. Drop the stale AGENTS.md reference from CLAUDE.md. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
87 lines
2.8 KiB
Markdown
87 lines
2.8 KiB
Markdown
# Contributing to kill-the-news
|
|
|
|
Thanks for your interest in contributing! This is a small, self-hosted
|
|
Cloudflare Worker project. Issues, bug fixes, and well-scoped features are all
|
|
welcome.
|
|
|
|
## Getting started
|
|
|
|
Requirements: Node.js (LTS) and npm. A Cloudflare account is only needed to
|
|
deploy, not to run tests locally.
|
|
|
|
```bash
|
|
git clone https://github.com/juherr/kill-the-news.git
|
|
cd kill-the-news
|
|
npm install # installs deps and builds client scripts (prepare hook)
|
|
npm run dev # start the local dev server (wrangler dev)
|
|
```
|
|
|
|
For full setup, deployment, and configuration details, see
|
|
[INSTALL.md](INSTALL.md).
|
|
|
|
## Development workflow
|
|
|
|
```bash
|
|
npm test # run all tests once
|
|
npm run test:watch # run tests in watch mode
|
|
npm run build # dry-run deploy bundle (wrangler deploy --dry-run)
|
|
npm run format # format with Prettier
|
|
```
|
|
|
|
Run a single test file:
|
|
|
|
```bash
|
|
npx vitest run src/routes/admin.test.ts
|
|
```
|
|
|
|
Client-side scripts live in `src/scripts/client/` and are compiled by esbuild
|
|
into `src/scripts/generated/` (gitignored). They rebuild on `npm install`; to
|
|
rebuild manually:
|
|
|
|
```bash
|
|
npm run build:client
|
|
```
|
|
|
|
The architecture, source layout, and KV schema are documented in
|
|
[CLAUDE.md](CLAUDE.md) — a good orientation before making changes.
|
|
|
|
## Before opening a pull request
|
|
|
|
- **Add or update tests** for any behavior change. Tests live in
|
|
`src/routes/*.test.ts`, with shared mocks in `src/test/setup.ts`.
|
|
- **Run the checks**: `npm test`, `npm run build`, and `npm run format`.
|
|
Pre-commit hooks (husky + lint-staged) run lint/format on staged files.
|
|
- **Keep docs in sync.** When you change behavior, update the relevant files
|
|
together:
|
|
- `README.md`
|
|
- `INSTALL.md` (setup, deployment, configuration)
|
|
- `setup.sh` (if setup/deploy assumptions changed)
|
|
- **Keep PRs focused.** One logical change per PR is easier to review.
|
|
|
|
## Commit messages
|
|
|
|
This project follows [Conventional Commits](https://www.conventionalcommits.org/)
|
|
with a scope, matching the existing history. Examples:
|
|
|
|
```
|
|
feat(admin): collapse create-feed form into accordion
|
|
fix(attachments): render inline cid: images in emails and feeds
|
|
refactor(home): dedupe byte formatting in storage cards
|
|
docs(readme): add Continuous deployment section
|
|
```
|
|
|
|
Common types: `feat`, `fix`, `refactor`, `docs`, `test`, `chore`.
|
|
|
|
## Reporting bugs and requesting features
|
|
|
|
Open an issue at
|
|
[github.com/juherr/kill-the-news/issues](https://github.com/juherr/kill-the-news/issues).
|
|
For bugs, include reproduction steps, expected vs. actual behavior, and your
|
|
environment (ingestion method, relevant config). For security issues, follow
|
|
[SECURITY.md](SECURITY.md) instead of opening a public issue.
|
|
|
|
## License
|
|
|
|
By contributing, you agree that your contributions will be licensed under the
|
|
[MIT License](LICENSE).
|