Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (37 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

54 lines (37 loc) · 1.61 KB

Contributing to the AXP Specification

Thank you for your interest in the AXP protocol specification. Contributions from the community help us build a better standard.

AXME is in alpha -- breaking changes may occur. We especially welcome feedback on API ergonomics.

Ways to Contribute

  • Propose schema changes or new lifecycle states
  • Report spec inconsistencies or ambiguities
  • Improve documentation clarity
  • Add conformance test cases

Reporting Issues

Open a GitHub Issue at https://github.com/AxmeAI/axp-spec/issues. Include:

  • Which section of the spec is affected
  • What the inconsistency or problem is
  • A suggested correction, if you have one

Proposing Changes

  1. Fork the repository.
  2. Create a branch from main (e.g., feat/add-lifecycle-state).
  3. Make your changes.
  4. Open a pull request against main with a clear description of what changed and why.

Style Guidelines

  • Write in clear, precise English. Avoid jargon where a simpler term works.
  • Schema definitions must be valid JSON Schema.
  • Use consistent terminology -- refer to existing spec sections for naming conventions.
  • Keep examples minimal but complete.

Review Process

All spec changes are reviewed for correctness, clarity, and backward compatibility. Expect discussion -- protocol changes affect every SDK and implementation downstream. Small fixes (typos, broken links) are merged quickly; schema or lifecycle changes require broader review.

Code of Conduct

Be respectful and constructive. We are building a shared standard and productive disagreement is welcome.

Contact

Questions or feedback: contact@axme.ai