Skip to content

docs: add SDK cleanup checklist and PR template - #330

Merged
El-swaggerito merged 1 commit into
Axionvera:mainfrom
euniceamoni:docs/add-cleanup-checklist
Jul 30, 2026
Merged

docs: add SDK cleanup checklist and PR template#330
El-swaggerito merged 1 commit into
Axionvera:mainfrom
euniceamoni:docs/add-cleanup-checklist

Conversation

@euniceamoni

@euniceamoni euniceamoni commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds contributor cleanup standards so every PR can be held to a consistent bar before review.


Type of change

  • Documentation only

What's included

  • docs/CLEANUP_CHECKLIST.md — 8-section reference document covering:

    • Module boundaries (barrel imports, no deep cross-module imports, circular dependency prevention)
    • Naming conventions (files, classes, errors, booleans, constants)
    • Import/export rules (explicit barrels, no wildcard re-exports, peer dependency handling)
    • Testing expectations (happy + error paths, file placement, approved mock helpers, no test.only)
    • Error and config conventions (AxionveraError subclasses, no hardcoded URLs, secrets never logged)
    • Documentation standards (TSDoc, docs/ updates, working examples)
    • Code quality (lint, typecheck, build, size, no console.log in library code)
    • Monorepo hygiene (package READMEs, shim exports, independent versioning)
  • .github/PULL_REQUEST_TEMPLATE.md — PR template with a condensed checkbox version of the checklist, plus standard metadata fields (summary, change type, testing, breaking changes).

  • README.md — Table of contents entry and a new ## 🧹 Cleanup Checklist section linking to both documents.


Testing

Documentation-only change. No source code modified. closes #325

- Add docs/CLEANUP_CHECKLIST.md covering module boundaries, naming
  conventions, import/export rules, testing expectations, error and
  config conventions, documentation standards, code quality, and
  monorepo hygiene
- Add .github/PULL_REQUEST_TEMPLATE.md with condensed checklist
  checkboxes and standard PR metadata fields
- Update README.md table of contents and add Cleanup Checklist section
  linking to both documents
@El-swaggerito
El-swaggerito merged commit 88c9097 into Axionvera:main Jul 30, 2026
1 check passed
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.

Add Axionvera SDK cleanup checklist

2 participants