docs: add SDK cleanup checklist and PR template - #330
Merged
El-swaggerito merged 1 commit intoJul 30, 2026
Conversation
- 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds contributor cleanup standards so every PR can be held to a consistent bar before review.
Type of change
What's included
docs/CLEANUP_CHECKLIST.md— 8-section reference document covering:test.only)AxionveraErrorsubclasses, no hardcoded URLs, secrets never logged)docs/updates, working examples)console.login library code).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 Checklistsection linking to both documents.Testing
Documentation-only change. No source code modified. closes #325