We want to make contributing to this project as easy and transparent as possible.
We use GitHub to track issues and feature requests, as well as accept pull requests.
You are welcome to contribute with your pull requests. These steps explain the contribution process:
- Fork the repository and create your branch from
main. - Add tests for your code.
- If you've changed APIs, update the documentation.
- Make sure the tests pass. Our GitHub actions pipeline is running the unit and e2e tests for your PR and will indicate any issues.
- Sign the Developer Certificate of Origin (DCO).
Run npm build to build the project.
The build artifacts will be stored in the dist/ directory.
NOTE: You should always add tests, if you are adding code to our repository.
Run npm test to execute the unit tests via Jest in the root directory of the repository.
We use GitHub issues to track bugs. Please ensure your description is clear and includes sufficient instructions to reproduce the issue.
By contributing to platform-mesh, you agree that your contributions will be licensed under its Apache-2.0 license.