Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
111 lines (73 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

111 lines (73 loc) · 2.32 KB
Raw

Contributing to RFQ-Spec

Thank you for helping make agent-to-manufacturer RFQs better!

How to Contribute

Reporting Issues

  • Bugs: Open an issue with bug label
  • Spec clarifications: Open an issue with question label
  • Feature requests: Open an issue with enhancement label

Proposing Changes

  1. Fork the repository
  2. Create a branch (git checkout -b feature/my-proposal)
  3. Make changes with clear commit messages
  4. Add tests/examples if applicable
  5. Open a Pull Request with detailed description

Types of Contributions

Specification Changes

For changes to SPEC.md or the JSON Schema:

  • Must include rationale
  • Should not break backward compatibility (use x- extensions for experiments)
  • Requires version bump following SemVer
  • Needs at least one example demonstrating the change

New Examples

  • Place in appropriate examples/ subdirectory
  • Must validate against current schema
  • Should demonstrate realistic manufacturing scenarios
  • Include comments explaining critical fields

Validation Scripts

  • Support latest schema version
  • Clear error messages
  • Exit code 0 on success, 1 on failure
  • Support both file and stdin input

Documentation

  • Typo fixes welcome anytime
  • Clarifications should cite specific spec sections
  • Translations welcome (create README.{lang}.md)

Commit Message Format

type(scope): subject

body (optional)

footer (optional)

Types:

  • spec: Changes to SPEC.md or schema
  • examples: New or updated examples
  • scripts: Validation tools
  • docs: Documentation changes
  • fix: Bug fixes

Examples:

spec(material): add titanium grade 5 specification

examples: add sheet metal bending RFQ

docs: clarify tolerance format in SPEC.md

Review Process

  1. Automated checks (schema validation, linting)
  2. Community review (minimum 3 days for spec changes)
  3. Maintainer approval
  4. Merge to main

Code of Conduct

  • Be respectful and constructive
  • Assume good intent
  • Focus on the specification, not the person
  • Remember: agents will use this too 🤖

Questions?

Built by humans and agents, together.