Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (45 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

59 lines (45 loc) · 2.33 KB
Raw

Contributing to Askr CLI

Thanks for helping improve the Askr command-line tools.

Organization contribution requirements

This repository follows the Askr organization contribution policy. Contributors must be using Askr, maintaining an Askr integration or community resource, or evaluating Askr for a concrete project. Pull requests must briefly describe that Askr context.

AI-assisted development and automation are welcome when disclosed. The person opening the pull request must personally review the contribution, be able to explain and maintain it, and remain available for substantive review follow-up. Unattended contributions and mass-generated changes from parties without a genuine interest in Askr are not accepted. New contributors should keep one pull request open at a time unless a maintainer agrees otherwise.

Local setup

Use a supported Node release from package.json, then install the exact locked dependencies:

npm ci

Run the local CI mirror before opening a pull request:

npm run check

Changes to project templates must also pass npm run test:templates. Changes to command startup, analysis, update planning, or SSG throughput should pass npm run bench. Changes that affect SSG compatibility should pass npm run test:peer-floor. npm audit should remain clean.

Changes

  • Describe the concrete Askr use, integration, or evaluation behind the change.
  • Disclose material AI or automation assistance, or state None.
  • Keep commits and pull-request titles in Conventional Commit form, such as feat(ssg): report output sizes or fix(update): preserve peer ranges.
  • Add focused tests for behavior changes and update the relevant page in docs/.
  • Update templates and their packed integration coverage together.
  • Update bundled skills, golden review prompts, and skill-system documentation together so generated guidance does not drift from CLI behavior.
  • Add user-visible changes to the [Unreleased] section of CHANGELOG.md.

Releases

Follow the release checklist. A chore(release): prepare @askrjs/cli X.Y.Z change must move the Unreleased entries into a dated version section; the normal npm run check gate verifies that the package version exists in the changelog.