This document defines baseline expectations for all contributors to maintain code quality, test coverage, and project stability.
Sign in to like and favorite skills
Here’s the updated AGENTS.md with a Doc Sync note so contributors know to check all public-facing docs together when changes happen:
This document defines baseline expectations for all contributors to maintain code quality, test coverage, and project stability.
CHANGELOG.md# Changelog All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
Update README.md when applicable: If changes make existing information incorrect, or if new features, usage instructions, or capabilities should be documented, update the README accordingly. Do not make unnecessary edits—only update when the change affects accuracy or completeness.
Doc Sync: When making changes that affect documentation, review README.md, CHANGELOG.md, and any other public-facing docs at the same time to ensure consistency.
Before committing changes:
Run all tests Ensure the full test suite passes locally without errors.
Lint the code Run the project's configured linter(s) or formatting tools.
Fix all linting or formatting issues Use auto-fix tools when available, and manually address any remaining issues.
Change Workflow
Implement changes in small, reviewable commits.
Write clear and descriptive commit messages.
Avoid pushing untested or lint-failing code.
PRs must pass all automated checks (tests, linting, builds) before requesting review.
Include a brief summary of the changes and their purpose.
Reference related issues or tickets when applicable.
Checklist Before Submitting Code
[ ] Updated or created tests.
[ ] All tests pass locally.
[ ] Linting run with no errors.
[ ] Updated or created CHANGELOG.md with notable changes.
[ ] Updated README.md if information is outdated or incomplete.
[ ] Verified documentation consistency (README.md, CHANGELOG.md, other public docs).
[ ] Commit messages are clear.
[ ] PR description explains the "why" and "what."