diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..17da73da7 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,3 @@ +# Community Code of Conduct + +Project Theia follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2b0b7f6c2..ad82ead8b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1 +1,24 @@ # Developer Guide + +Thank you for taking the time out to contribute to project Theia! Project Theia follows the [Antrea Developer Guide]. +Also check out [Theia documents](docs) for more information about Theia. + +## Notice + +The following sections have different content from [Antrea Developer Guide]. Please read them carefully when referring +to [Antrea Developer Guide]. + +### GitHub Workflow + +When following [Github Workflow in Antrea](https://github.com/antrea-io/antrea/blob/main/CONTRIBUTING.md#github-workflow), +please make sure to change the name of repository from `antrea` to `theia`. + +### Getting your PR verified by CI + +In Theia, we have only one trigger phrase for individual checks: + +* `/theia-test-e2e`: Theia e2e tests + +For more information about the tests we run as part of CI, please refer to [ci/README.md](ci/README.md). + +[Antrea Developer Guide]: https://github.com/antrea-io/antrea/blob/main/CONTRIBUTING.md diff --git a/GOVERNANCE.md b/GOVERNANCE.md index ea9cf8af9..f24e85475 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -1 +1,11 @@ # Theia Governance + +Project Theia follows the [Antrea governance](https://github.com/antrea-io/antrea/blob/main/GOVERNANCE.md). + +## Contributors + +Anyone can contribute to the project (e.g. open a PR) as long as they follow the guidelines in [CONTRIBUTING.md](CONTRIBUTING.md). + +## Maintainers + +The list of current Theia maintainers can be found in [MAINTAINERS.md](MAINTAINERS.md). diff --git a/MAINTAINERS.md b/MAINTAINERS.md index ed911f8b2..034a0f0a2 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -1 +1,12 @@ # Theia Maintainers + +This is the current list of maintainers for the Theia project. The maintainer +role is described in [GOVERNANCE.md](GOVERNANCE.md). + +| Maintainer | GitHub ID | Affiliation | +|-------------------|--------------|-------------| +| Antonin Bas | antoninbas | VMware | +| Jianjun Shen | jianjuns | VMware | +| Quan Tian | tnqn | VMware | +| Salvatore Orlando | salv-orlando | VMware | +| Ziyou Wang | ziyouw | VMware | diff --git a/SECURITY.md b/SECURITY.md index 15f91cfb2..1a4f571d4 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1 +1,3 @@ # Security Procedures + +Project Theia follows the [Antrea security procedures](https://github.com/antrea-io/antrea/blob/main/SECURITY.md). diff --git a/ci/README.md b/ci/README.md new file mode 100644 index 000000000..d9b777b3f --- /dev/null +++ b/ci/README.md @@ -0,0 +1,8 @@ +# Theia CI + +Project Theia follows [Antrea CI](https://github.com/antrea-io/antrea/blob/main/ci/README.md). + +## Notice + +1. At the moment, we don't support integration tests in Theia. +2. For information about our Jenkins CI jobs, please see [here](jenkins/README.md).