This is an automated email from the ASF dual-hosted git repository. zfc pushed a commit to branch build-env in repository https://gitbox.apache.org/repos/asf/incubator-teaclave-website.git
commit 2512098cdd2312fb20cffe985e0b100fcece77d8 Author: Zhaofeng Chen <[email protected]> AuthorDate: Mon May 5 03:35:37 2025 +0000 [Add] Contributing.md and modify the community sidebar. --- site/.vuepress/config.js | 13 +++++-- site/community.md | 4 +-- site/contributing.md | 88 ++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 100 insertions(+), 5 deletions(-) diff --git a/site/.vuepress/config.js b/site/.vuepress/config.js index 75d6630a6..c8a974e09 100644 --- a/site/.vuepress/config.js +++ b/site/.vuepress/config.js @@ -8,7 +8,7 @@ module.exports = { '*.md', 'api-docs/*.md', 'blog/*.md', - 'teaclave/**/*.md', + 'teaclave/*/*.md', 'teaclave-sgx-sdk/documents/*.md', 'teaclave-trustzone-sdk/docs', '!teaclave/sdk/rust/target/**', @@ -35,9 +35,15 @@ module.exports = { nav: [ { text: 'ABOUT', link: '/' }, { text: 'POWERED BY', link: '/powered-by/' }, - { text: 'COMMUNITY', link: '/community/' }, + { + text: 'COMMUNITY', + link: '/community/', + items: [ + { text: 'CONTRIBUTING', link: '/contributing/' }, + { text: 'CONTRIBUTORS', link: '/contributors/' }, + ] + }, { text: 'DOWNLOAD', link: '/download/' }, - { text: 'CONTRIBUTORS', link: '/contributors/' }, { text: 'DOCS', link: '/docs/', @@ -290,3 +296,4 @@ module.exports = { }]) }, } + diff --git a/site/community.md b/site/community.md index aad529919..5d473651a 100644 --- a/site/community.md +++ b/site/community.md @@ -41,8 +41,8 @@ Follow [@ApacheTeaclave](https://twitter.com/ApacheTeaclave) for latest news. Teaclave is open source in [The Apache Way](https://www.apache.org/theapacheway/), we aim to create a project that is maintained and owned by the community. All -kinds of contributions are welcome. Read this [document](CONTRIBUTING.md) to -learn more about how to contribute. Huge thanks to our [contributors](CONTRIBUTORS.md). +kinds of contributions are welcome. Read this [contributing document](/contributing/) to +learn more about how to contribute. Huge thanks to our [contributors](/contributors/). ## Event Calendar diff --git a/site/contributing.md b/site/contributing.md new file mode 100644 index 000000000..ec24bb1cd --- /dev/null +++ b/site/contributing.md @@ -0,0 +1,88 @@ +--- +permalink: /contributing +sidebar: false +--- + +# Contributing + +Teaclave is open source and follows [The Apache Way](https://www.apache.org/theapacheway/). +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: + +- [Teaclave](https://github.com/apache/incubator-teaclave) +- [Teaclave SGX SDK](https://github.com/apache/incubator-teaclave-sgx-sdk) +- [Teaclave TrustZone SDK](https://github.com/apache/incubator-teaclave-trustzone-sdk) +- [Teaclave Java TEE SDK](https://github.com/apache/incubator-teaclave-java-tee-sdk) +- [Teaclave Website](https://github.com/apache/incubator-teaclave-website) + +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: +**[email protected]** + +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: +**[email protected]** +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](https://www.apache.org/foundation/policies/conduct). +We expect all contributors to adhere to it. + +Thank you for your interest in contributing to Teaclave! \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
