The repository currently does not include a CONTRIBUTING.md file.
While the README provides excellent documentation for installing and using the SDK, there is no guide describing the development workflow for contributors.
A dedicated CONTRIBUTING.md would make it easier for new contributors to get started and reduce the need to inspect CI workflows or source code to understand the expected development process.
Some useful topics could include:
- Setting up a local development environment
- Installing development dependencies
- Running the test suite
- Running linting and formatting before submitting a PR
- Repository structure and where to start
- Pull request expectations (commit messages, code style, review process, etc.)
This would improve the onboarding experience for both first-time and returning contributors.
I'd be happy to work on this if it would be a useful addition.
The repository currently does not include a
CONTRIBUTING.mdfile.While the README provides excellent documentation for installing and using the SDK, there is no guide describing the development workflow for contributors.
A dedicated
CONTRIBUTING.mdwould make it easier for new contributors to get started and reduce the need to inspect CI workflows or source code to understand the expected development process.Some useful topics could include:
This would improve the onboarding experience for both first-time and returning contributors.
I'd be happy to work on this if it would be a useful addition.