Skip to content

Latest commit

 

History

History
54 lines (33 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

54 lines (33 loc) · 2.33 KB

Contributing to ORFS

Thank you for your interest in contributing to the Open Restaurant Feed Specification (ORFS)! This document provides guidelines for contributions and outlines the process for proposing changes to the specification.

Code of Conduct

All participants in the ORFS project are expected to adhere to professional conduct and respect all contributors regardless of background.

How to Contribute

There are several ways to contribute to ORFS:

  1. Report bugs or suggest enhancements: If you find a problem with the specification or have an idea for improvement, please open an issue in the GitHub repository.

  2. Submit pull requests: If you've fixed a bug or implemented an enhancement, you can submit a pull request.

  3. Improve documentation: Help us improve the documentation by fixing typos, clarifying explanations, or adding examples.

  4. Provide feedback: Review proposed changes and provide feedback on GitHub issues and pull requests.

Proposing Changes to the Specification

ORFS follows a formal change proposal process:

  1. Draft a proposal: Create a new issue that describes your proposed change. Include:

    • A clear description of the change
    • The motivation for the change
    • Potential impact on backward compatibility
    • Implementation examples

  2. Community discussion: The proposal will be open for community discussion and feedback.

  3. Working group review: The ORFS working group will review the proposal and determine if it should be accepted.

  4. Implementation: If accepted, the change will be implemented and added to the next release of the specification.

Versioning

ORFS follows semantic versioning:

  • Major version changes indicate backward-incompatible changes
  • Minor version changes indicate new, backward-compatible functionality
  • Patch version changes indicate backward-compatible bug fixes

Pull Request Process

  1. Fork the repository and create a new branch for your contribution.
  2. Make your changes, following our coding and documentation standards.
  3. Ensure any new code or schema changes have appropriate tests.
  4. Update the documentation to reflect your changes.
  5. Submit a pull request with a clear description of the changes.

License

By contributing to ORFS, you agree that your contributions will be licensed under the project's Apache License 2.0.