Skip to content

docs: document generated files and release conventions #162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
toddr merged 1 commit into from
Apr 3, 2026
Merged

docs: document generated files and release conventions #162

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,21 @@ typedef struct {

Tests use dynamic plans (hash algorithm availability varies by OpenSSL build). `t/fakelib/` provides a mock `Crypt::OpenSSL::Bignum` for testing without the real module.

## Generated Files — Do Not Edit

These files are generated and must not be manually edited or committed:

- **`MANIFEST`** — Generated by `make manifest`. Do not sort or modify by hand.
- **`README.md`** — Generated from POD via `pod2markdown RSA.pm > README.md`. Edit the POD in `RSA.pm` instead.

## Release Process — Human Only

Releases are performed by the maintainer. Automated fixes must **never**:

- Update `Changes` / changelog entries
- Bump the version number in `RSA.pm` or elsewhere
- Modify release metadata (META.json, META.yml)

## Conventions & Gotchas

### Memory Management
Expand Down
Loading