Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (42 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

64 lines (42 loc) · 2.14 KB

Contributing to Codex Document Format

Thank you for your interest in contributing to the Codex Document Format specification.

How to Contribute

Reporting Issues

  • Use GitHub Issues for bug reports, specification questions, and feature requests
  • Search existing issues before creating a new one
  • Provide clear, detailed descriptions

Proposing Changes

  1. Open an Issue First: For significant changes, open an issue to discuss the proposal before submitting a PR
  2. Fork and Branch: Create a feature branch from main
  3. Follow Standards: Adhere to the specification writing style (see below)
  4. Submit PR: Reference the related issue in your PR description

Specification Writing Style

  • Use clear, unambiguous language
  • Follow RFC 2119 for requirement levels (MUST, SHOULD, MAY)
  • Include rationale for design decisions
  • Provide examples for complex concepts
  • Reference external standards precisely (include version numbers)

Code Contributions

For reference implementation and tooling:

  • TypeScript with strict type checking
  • Comprehensive test coverage
  • Clear documentation

Decision Process

Currently using informal consensus with project maintainers having final say. This will evolve as the community grows.

Code of Conduct

  • Be respectful and constructive
  • Focus on technical merit
  • Welcome newcomers

Intellectual Property

By contributing, you agree that your contributions will be licensed under Apache License 2.0.

All contributors must agree to the following:

  • You have the right to submit the contribution
  • You grant license to use your contribution
  • Your contribution does not include patented material (or you grant patent license)

Getting Help

Recognition

Contributors will be acknowledged in the project documentation.