Commit graph

4 commits

Author SHA1 Message Date
jedarden
569999898a docs(pdftract-4618): adopt Contributor Covenant v2.1 and link from templates
- Update CODE_OF_CONDUCT.md to official Contributor Covenant v2.1 text
- Change enforcement contact from security@jedarden.com to community@jedarden.com
- Add links to CODE_OF_CONDUCT.md from all issue templates
- Add Code of Conduct link to README Contributing section

Satisfies GitHub Community Standards requirement for CODE_OF_CONDUCT.md
linked from issue templates and README.

Refs: pdftract-4618
Signed-off-by: jedarden <github@jedarden.com>
2026-05-24 13:06:57 -04:00
jedarden
2573dba8ed docs(pdftract-f29c): implement GitHub Issue Forms and PR templates
Converted GitHub issue templates from Markdown to YAML Issue Forms with
required field enforcement. Added documentation template. Updated PR
template with local validation checkbox.

Changes:
- Added config.yml to disable blank issues and route to Discussions/Security
- Converted bug_report, feature_request, performance_regression to .yml forms
- Added documentation.yml template for docs issues
- Updated security.yml as reference redirect to SECURITY.md
- Updated PULL_REQUEST_TEMPLATE.md with local validation checkbox
- Bug template enforces pdftract doctor output as required field

Closes: pdftract-f29c

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-24 06:43:48 -04:00
jedarden
97fecb7b4b docs(contributing): add Argo-CI caveat, DCO sign-off, and contributor templates
- Restructured CONTRIBUTING.md with all nine required sections:
  - Project licensing (MIT OR Apache-2.0, DCO sign-off required)
  - Code of conduct (Contributor Covenant v2.1)
  - Security reporting (link to SECURITY.md)
  - Development setup (with OCR dependencies)
  - Local validation checklist (6 commands matching pdftract-ci)
  - CI on forks caveat (maintainer-triggered, 48-hour response)
  - PR template requirements
  - Commit message style (Conventional Commits)
  - Issue triage

- Created CODE_OF_CONDUCT.md (Contributor Covenant v2.1)

- Created .github/PULL_REQUEST_TEMPLATE.md with required fields:
  - Linked issue or RFC
  - Scope statement (Phase / Acceptance Scenario)
  - Test plan
  - Manual-test evidence
  - Performance impact

- Created issue templates:
  - bug_report.md (with pdftract doctor output requirement)
  - feature_request.md (with use case and proposed solution)
  - performance_regression.md (with baseline vs current)

- Updated README.md with Contributing section linking to CONTRIBUTING.md

- Added footer links to CONTRIBUTING.md in all templates

Closes: pdftract-i9rk

Verification: notes/pdftract-i9rk.md
Signed-off-by: jedarden <github@jedarden.com>
2026-05-24 06:00:48 -04:00
jedarden
bb5346b305 docs(pdftract-58kz): add security policy documentation
Add comprehensive SECURITY.md covering:
- Supported versions policy
- Private vulnerability reporting (email + GitHub)
- 90-day disclosure window with timelines
- CVE assignment via GitHub Security Advisories
- In-scope and out-of-scope vulnerability classes
- Safe harbor policy for good-faith researchers

Add security issue template redirecting users to private reporting.
Add Security section to CONTRIBUTING.md and README.md with links to SECURITY.md.
Add docs/security/pgp-public-key.asc placeholder with generation instructions.

References: bead pdftract-58kz, plan line 3433

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-20 19:39:24 -04:00