Skip to main content

Contributing

Teaclave is open source and follows The Apache Way. We aim to create a project that is maintained and owned by the community. All kinds of contributions are welcome.

We encourage community contributions in many forms, including source code, documentation, bug reports, discussions, and outreach.

Source Code

For source code contributions, please refer to the respective GitHub repositories:

Please open a pull request to the relevant repository with a clear explanation of your changes. Follow any contribution guidelines and coding conventions described in the repo.

Bug Reports

For bug reports, please use the GitHub "Issues" tab in the relevant repository. Timely responses and triage will be performed by the maintainers.

We recommend using the following format when reporting:

## Environment:
- OS and version
- Hardware and platform
- Compiler/toolchain versions

## Steps to reproduce:
1. ...
2. ...
3. ...

## Expected behavior:
...

## Actual behavior:
...

## Additional context:
...

Security Report

For reporting security vulnerabilities, please contact us privately at: private@teaclave.apache.org

Do not disclose vulnerabilities publicly before we have addressed them. We treat security issues with the highest priority and will respond as promptly as possible.

Documentation

Documentation improvements are highly appreciated.

Please feel free to submit Pull Requests for updates, fixes, or additions to any of the documentation found in our repositories.

Discussion

For general discussions, questions, or suggestions, please reach out via email to: general@teaclave.apache.org We value constructive discussion and community engagement.

Marketing and Outreach

We also welcome contributions that help promote the project, such as writing blog posts, presenting at conferences, or translating documentation.

Please let us know about such efforts so we can help amplify your work and coordinate effectively.

Code of Conduct

Teaclave follows the Apache Code of Conduct. We expect all contributors to adhere to it.

Thank you for your interest in contributing to Teaclave!