Skip to content

Latest commit

 

History

History
30 lines (17 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

30 lines (17 loc) · 1.5 KB

Contributing

This monorepo hosts two projects:

  • specstory-cli - the SpecStory CLI (Go). Guidance below.
  • lore - SpecStory Lore, the skill that forges agent skills from your session histories (zero-dependency Node). See lore/CONTRIBUTING.md for its rules (fixtures-are-the-spec, golden files, lore/vX.Y.Z release tags).

Contributing to the SpecStory CLI

Getting Started

The Develoment section of the README.md covers getting started with development on the SpecStory CLI.

Technical Standards

The directions we provide to agents in CLAUDE.md is excellent information on the technical standards for the project, and applies equally to the human participants in the project.

Ensure all tests pass and linting is clean before submitting a pull request.

Contributions can be pre-reviewed with the Claude Code command code-review. This same prompt can be adapted for use with any other coding agent as well.

Pull requests can be pre-reviewed with the Clade Code command pr-review. This same prompt can be adapted for use with any other coding agent as well.

Technical Communication & Code of Conduct

All technical communication in the project (issues, PR's, code comments, etc.) is in English.

All project communication is subject to the Code of Conduct.