mirror of https://github.com/xroche/httrack.git synced 2026-06-29 05:26:32 +03:00

Files

Xavier Roche 594820d3eb Add AGENTS.md operational checklist for AI-assisted contributions

LLM-assisted PRs are arriving; give agents one compact, tool-neutral file
covering the repo's toolchain rules and invariants so contributions arrive
review-ready instead of needing the conventions reconstructed each time.

AGENTS.md is the operational checklist (build/test, autotools regen, touched-
lines-only formatting, byte-safe Latin-1 edits, overflow-safe bounds,
adversarial self-review, commit/PR discipline). CLAUDE.md imports it via
@AGENTS.md so Claude Code auto-loads the same source. CONTRIBUTING.md keeps the
policy and gains a Co-Authored-By attribution rule plus a PR-conciseness line.

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Xavier Roche <roche@httrack.com>

2026-06-16 04:01:29 +02:00

1.7 KiB

Raw Blame History

Contributing to HTTrack

HTTrack is small and old. Keep changes easy to review and safe to merge. Working with an AI assistant? The operational checklist is AGENTS.md.

Pull requests

One change per PR. Small diffs merge fast.
PRs land as a merge commit, so the branch's commits go onto master as-is: keep each commit message clean and explain why.
Be terse in the PR title and description: name the problem, not the fix, don't restate the diff, and calibrate length to the change.
Add or update tests for engine changes (tests/), and keep CI green.

Style

C, matching nearby code. Format only the lines you change (git clang-format against the repo .clang-format). Never reformat untouched code.
Comment the why, in English.
HTTrack parses hostile input off the network. Check bounds, avoid unchecked copies, and never let an attacker-controlled length drive arithmetic unchecked.

Sign your work

Every commit needs a Signed-off-by line, the DCO: git commit -s. CI rejects unsigned commits; fix a branch with git rebase --signoff master.

AI assistants

Welcome, and nothing to disclose. Two rules:

Own every line as if you wrote it. Can't explain it in review? Not ready.
Don't push your work onto reviewers. A raw generated patch a maintainer has to vet from scratch will be closed.
Attribution is mandatory. AI-assisted commits must carry a Co-Authored-By: trailer naming the assistant, not a footer in the PR description.

The sign-off covers AI-assisted code too.

Bugs

Open an issue with the version, OS, command used, and expected vs actual result. For security issues see SECURITY.md, not a public issue.

1.7 KiB Raw Blame History