Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (24 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

46 lines (24 loc) · 1.89 KB

Contributing to join.cloud

How to contribute

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you can't find an open issue addressing the problem, open a new one. Include a clear title and description, steps to reproduce, and — if possible — a minimal code sample demonstrating the issue.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the fix.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

  • Make sure npm run build compiles with zero errors and npm test passes before submitting.

Did you fix whitespace, format code, or make a purely cosmetic patch?

Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of join.cloud will generally not be accepted.

Do you intend to add a new feature or change an existing one?

  • Open an issue first to discuss the change before writing code. This helps avoid wasted effort if the feature doesn't align with the project's direction.

  • Do not open a pull request until there's agreement on the approach.

Does your change affect the public API?

If your change touches the SDK, MCP tools, or A2A actions:

  • Update the relevant documentation in docs/
  • Add or update tests in test/

Do you have questions about how to use join.cloud?

  • Check the README first.

  • If you still have questions, open a discussion. The project is actively maintained.

License

By contributing, you agree that your contributions will be licensed under the AGPL-3.0 License.

Thanks for helping make join.cloud better!