Skip to content

Latest commit

 

History

History
90 lines (56 loc) · 3.64 KB

CONTRIBUTING.md

File metadata and controls

90 lines (56 loc) · 3.64 KB

Contributing

Thank you for your interest in contributing to this repository!

This repository contains two independent projects:

  • ROSS – An open-source, configuration-driven backend API framework licensed under MIT.
  • Rocket – A source-available backend deployment and hosting platform licensed under PolyForm Shield 1.0.0.

Although both projects live in the same repository, they have different licensing terms. Please read the relevant section before submitting a contribution.

1. General Guidelines

We welcome bug reports, feature suggestions, documentation improvements, and code contributions.

Before submitting a contribution:

  1. Check existing issues and pull requests to avoid duplicate work.
  2. For significant changes, open an issue first to discuss the proposed implementation.
  3. Keep pull requests focused on a single concern.
  4. Include tests for new functionality and bug fixes wherever applicable.
  5. Update documentation when introducing or changing functionality.
  6. Follow the existing conventions and patterns used within the respective project.

2. Contributing to ROSS

ROSS is licensed under the MIT License.

Contributions to ROSS are welcomed under the same MIT licensing model.

By submitting a contribution to ROSS:

  • You retain copyright ownership of your original contribution.
  • You agree that your contribution will be made available under the MIT License.
  • You confirm that you have the necessary rights to submit the contribution.
  • You confirm that your contribution does not knowingly violate another party's intellectual property rights.

The MIT License permits commercial use, modification, distribution, and sublicensing of the software.

Refer to ross/LICENSE for the complete license terms.

3. Contributing to Rocket

Rocket is licensed under the PolyForm Shield License 1.0.0.

Rocket is source-available, not open-source. Its source code is publicly accessible, but its use is subject to the restrictions defined in its license.

We welcome contributions to Rocket, subject to the project's licensing terms.

By submitting a contribution to Rocket:

  • You retain copyright ownership of your original contribution.
  • You agree that your contribution will be made available under the PolyForm Shield License 1.0.0.
  • You confirm that you have the necessary rights to submit the contribution.
  • You understand that contributions are subject to the same license restrictions as the rest of Rocket.

Contributions must not introduce code, assets, or dependencies that violate third-party intellectual property rights or their applicable licenses.

Refer to rocket/LICENSE for the complete license terms.

4. Pull Request Process

When submitting a pull request:

  1. Provide a clear and descriptive title.
  2. Explain the problem being addressed and the proposed solution.
  3. Include relevant context, screenshots, or examples where applicable.
  4. Mention any related issues.
  5. Ensure all applicable tests pass.
  6. Be responsive to review feedback.

Pull requests may be reviewed, updated, or declined at the maintainers' discretion.

5. Code Quality

  • Keep implementations simple and maintainable.
  • Avoid unnecessary abstractions and dependencies.
  • Write meaningful commit messages.
  • Add tests for new functionality.
  • Update relevant documentation.
  • Avoid introducing breaking changes without prior discussion.

Please follow the conventions and patterns already established within the project you are contributing to.

6. Questions and Discussions

For questions, feature requests, bug reports, or architectural discussions, please use the repository's GitHub Issues.

We appreciate your interest in contributing to ROSS and Rocket.