mirror of
https://github.com/alibaba/higress.git
synced 2026-05-10 05:47:26 +08:00
docs: align CNCF onboarding governance and README compliance
Add lightweight project governance guidance and refine README community/legal sections to satisfy CNCF onboarding requirements while avoiding redundant CNCF statements. Change-Id: I77178b6fe426675da619bdcb2d899f2a76ae8b5b Co-developed-by: Cursor <noreply@cursor.com> Signed-off-by: EndlessSeeker <1766508902@qq.com>
This commit is contained in:
EndlessSeeker
@@ -1,4 +1,22 @@
|
||||
# Contributor Covenant Code of Conduct
|
||||
# Higress Code of Conduct
|
||||
|
||||
Higress is a [Cloud Native Computing Foundation](https://www.cncf.io/) sandbox
|
||||
project. As a CNCF project, the Higress community follows the
|
||||
[**CNCF Code of Conduct**](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).
|
||||
|
||||
The text below is the project's adopted Code of Conduct, based on the
|
||||
[Contributor Covenant](https://www.contributor-covenant.org/), and is
|
||||
substantively aligned with the CNCF Code of Conduct. Where any conflict exists,
|
||||
the CNCF Code of Conduct prevails.
|
||||
|
||||
Instances of unacceptable behavior may be reported to the project maintainers
|
||||
at [higress@googlegroups.com](mailto:higress@googlegroups.com), or to the CNCF
|
||||
Code of Conduct Committee at
|
||||
[conduct@cncf.io](mailto:conduct@cncf.io).
|
||||
|
||||
---
|
||||
|
||||
## Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
|
||||
50
GOVERNANCE.md
Normal file
50
GOVERNANCE.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# Higress Governance
|
||||
|
||||
Higress is a [Cloud Native Computing Foundation (CNCF)](https://www.cncf.io/)
|
||||
sandbox project. This document describes the project's open governance model.
|
||||
|
||||
All community members must follow the
|
||||
[**CNCF Code of Conduct**](https://github.com/cncf/foundation/blob/main/code-of-conduct.md)
|
||||
and the project's adopted policy in [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md).
|
||||
|
||||
## Values
|
||||
|
||||
Higress governance is guided by the following values:
|
||||
|
||||
- **Openness**: Communication and decision making happen in public channels and repositories whenever possible.
|
||||
- **Fairness**: Contributions are evaluated on technical merit rather than company affiliation.
|
||||
- **Community First**: Long-term community health has priority over short-term product goals.
|
||||
- **Inclusivity**: We welcome contributors from different regions and backgrounds.
|
||||
- **Participation**: Project responsibilities are earned through sustained contribution.
|
||||
|
||||
## Roles
|
||||
|
||||
Higress role definitions are documented in:
|
||||
|
||||
- [`MAINTAINERS.md`](./MAINTAINERS.md)
|
||||
- [`CODEOWNERS`](./CODEOWNERS)
|
||||
- [`CONTRIBUTING_EN.md`](./CONTRIBUTING_EN.md)
|
||||
|
||||
## Decision Making
|
||||
|
||||
Higress uses **lazy consensus** by default.
|
||||
|
||||
When consensus cannot be reached, maintainers may start a vote on a public
|
||||
issue or pull request. A simple majority of votes cast decides the outcome.
|
||||
|
||||
For governance or project direction changes, maintainers should allow adequate
|
||||
time for public discussion before finalizing decisions.
|
||||
|
||||
## Governance Updates
|
||||
|
||||
Changes to this document are made through pull requests and approved by
|
||||
maintainers.
|
||||
|
||||
## Security
|
||||
|
||||
Security reporting and response follow [`SECURITY.md`](./SECURITY.md).
|
||||
|
||||
---
|
||||
|
||||
Higress is a [Cloud Native Computing Foundation](https://www.cncf.io/) sandbox
|
||||
project.
|
||||
38
README.md
38
README.md
@@ -11,6 +11,8 @@
|
||||
[](https://github.com/alibaba/higress/actions)
|
||||
[](https://www.apache.org/licenses/LICENSE-2.0.html)
|
||||
[](https://discord.gg/tSbww9VDaM)
|
||||
[](https://www.cncf.io/projects/)
|
||||
[](https://www.bestpractices.dev/)
|
||||
|
||||
<a href="https://trendshift.io/repositories/10918" target="_blank"><img src="https://trendshift.io/api/badge/repositories/10918" alt="alibaba%2Fhigress | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a> <a href="https://www.producthunt.com/posts/higress?embed=true&utm_source=badge-featured&utm_medium=badge&utm_souce=badge-higress" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=951287&theme=light&t=1745492822283" alt="Higress - Global APIs as MCP powered by AI Gateway | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
|
||||
|
||||
@@ -183,6 +185,25 @@ Join our Discord community! This is where you can connect with developers and ot
|
||||
|
||||
[](https://discord.gg/tSbww9VDaM)
|
||||
|
||||
### Code of Conduct
|
||||
|
||||
The Higress community follows the
|
||||
[**CNCF Code of Conduct**](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).
|
||||
The project's adopted Code of Conduct is documented in
|
||||
[`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md). Please review it before
|
||||
participating in the community.
|
||||
|
||||
### Governance & Maintainers
|
||||
|
||||
Project governance, the maintainer roster, and the contribution model are
|
||||
described in [`GOVERNANCE.md`](./GOVERNANCE.md) and
|
||||
[`MAINTAINERS.md`](./MAINTAINERS.md). New contributors are encouraged to start
|
||||
with [`CONTRIBUTING_EN.md`](./CONTRIBUTING_EN.md).
|
||||
|
||||
### Security
|
||||
|
||||
Please report security vulnerabilities following the process described in
|
||||
[`SECURITY.md`](./SECURITY.md).
|
||||
|
||||
### Thanks
|
||||
|
||||
@@ -205,6 +226,23 @@ Higress would not be possible without the valuable open-source work of projects
|
||||
|
||||
[](https://star-history.com/#alibaba/higress&Date)
|
||||
|
||||
---
|
||||
|
||||
## Cloud Native Computing Foundation
|
||||
|
||||
<a href="https://www.cncf.io/projects/" target="_blank">
|
||||
<img src="https://raw.githubusercontent.com/cncf/artwork/master/other/cncf/horizontal/color/cncf-color.svg" alt="Cloud Native Computing Foundation" width="300"/>
|
||||
</a>
|
||||
|
||||
We are a [Cloud Native Computing Foundation](https://www.cncf.io/) sandbox project.
|
||||
|
||||
The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For
|
||||
a list of TLF trademarks, see [Trademark Usage](https://www.linuxfoundation.org/legal/trademark-usage).
|
||||
|
||||
Copyright Higress a Series of LF Projects, LLC. For website terms of use,
|
||||
trademark policy and other project policies please see
|
||||
[https://lfprojects.org/policies/](https://lfprojects.org/policies/).
|
||||
|
||||
<p align="right" style="font-size: 14px; color: #555; margin-top: 20px;">
|
||||
<a href="#readme-top" style="text-decoration: none; color: #007bff; font-weight: bold;">
|
||||
↑ Back to Top ↑
|
||||
|
||||
36
README_JP.md
36
README_JP.md
@@ -8,6 +8,8 @@
|
||||
|
||||
[](https://github.com/alibaba/higress/actions)
|
||||
[](https://www.apache.org/licenses/LICENSE-2.0.html)
|
||||
[](https://www.cncf.io/projects/)
|
||||
[](https://www.bestpractices.dev/)
|
||||
|
||||
[**公式サイト**](https://higress.cn/) |
|
||||
[**ドキュメント**](https://higress.cn/docs/latest/overview/what-is-higress/) |
|
||||
@@ -190,6 +192,23 @@ K8sでのHelmデプロイなどの他のインストール方法については
|
||||
|
||||
## コミュニティ
|
||||
|
||||
### 行動規範（Code of Conduct）
|
||||
|
||||
Higress コミュニティは
|
||||
[**CNCF Code of Conduct**](https://github.com/cncf/foundation/blob/main/code-of-conduct.md)
|
||||
に従っています。プロジェクトが採用している行動規範は
|
||||
[`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md) に記載されていますので、コミュニティに参加する前にご確認ください。
|
||||
|
||||
### ガバナンスとメンテナー
|
||||
|
||||
プロジェクトのガバナンス、メンテナー一覧、コントリビューションモデルについては
|
||||
[`GOVERNANCE.md`](./GOVERNANCE.md) と [`MAINTAINERS.md`](./MAINTAINERS.md) を参照してください。
|
||||
初めて貢献される方は [`CONTRIBUTING_EN.md`](./CONTRIBUTING_EN.md) からお読みください。
|
||||
|
||||
### セキュリティ
|
||||
|
||||
セキュリティに関する脆弱性は [`SECURITY.md`](./SECURITY.md) に記載された手順に従って報告してください。
|
||||
|
||||
### 感謝
|
||||
|
||||
EnvoyとIstioのオープンソースの取り組みがなければ、Higressは実現できませんでした。これらのプロジェクトに最も誠実な敬意を表します。
|
||||
@@ -221,6 +240,23 @@ WeChat公式アカウント：
|
||||
|
||||
[](https://star-history.com/#alibaba/higress&Date)
|
||||
|
||||
---
|
||||
|
||||
## Cloud Native Computing Foundation
|
||||
|
||||
<a href="https://www.cncf.io/projects/" target="_blank">
|
||||
<img src="https://raw.githubusercontent.com/cncf/artwork/master/other/cncf/horizontal/color/cncf-color.svg" alt="Cloud Native Computing Foundation" width="300"/>
|
||||
</a>
|
||||
|
||||
Higress は [Cloud Native Computing Foundation](https://www.cncf.io/) のサンドボックスプロジェクトです。
|
||||
|
||||
The Linux Foundation® (TLF) は登録商標を所有し使用しています。LF の商標一覧については
|
||||
[Trademark Usage](https://www.linuxfoundation.org/legal/trademark-usage) をご参照ください。
|
||||
|
||||
Copyright Higress a Series of LF Projects, LLC. ウェブサイトの利用規約、商標ポリシー、
|
||||
その他のプロジェクトポリシーについては
|
||||
[https://lfprojects.org/policies/](https://lfprojects.org/policies/) をご参照ください。
|
||||
|
||||
<p align="right" style="font-size: 14px; color: #555; margin-top: 20px;">
|
||||
<a href="#readme-top" style="text-decoration: none; color: #007bff; font-weight: bold;">
|
||||
↑ トップに戻る ↑
|
||||
|
||||
33
README_ZH.md
33
README_ZH.md
@@ -10,6 +10,8 @@
|
||||
|
||||
[](https://github.com/alibaba/higress/actions)
|
||||
[](https://www.apache.org/licenses/LICENSE-2.0.html)
|
||||
[](https://www.cncf.io/projects/)
|
||||
[](https://www.bestpractices.dev/)
|
||||
|
||||
<a href="https://trendshift.io/repositories/10918" target="_blank"><img src="https://trendshift.io/api/badge/repositories/10918" alt="alibaba%2Fhigress | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a> <a href="https://www.producthunt.com/posts/higress?embed=true&utm_source=badge-featured&utm_medium=badge&utm_souce=badge-higress" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=951287&theme=light&t=1745492822283" alt="Higress - Global APIs as MCP powered by AI Gateway | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
|
||||
</div>
|
||||
@@ -221,6 +223,21 @@ K8s 下使用 Helm 部署等其他安装方式可以参考官网 [Quick Start
|
||||
|
||||
## 社区
|
||||
|
||||
### 行为准则（Code of Conduct）
|
||||
|
||||
Higress 社区遵循 [**CNCF Code of Conduct**](https://github.com/cncf/foundation/blob/main/code-of-conduct.md)。
|
||||
项目采纳的行为准则详见 [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md)，参与社区前请先阅读。
|
||||
|
||||
### 治理与维护者
|
||||
|
||||
项目治理、维护者名单与贡献模型分别记录于 [`GOVERNANCE.md`](./GOVERNANCE.md) 与
|
||||
[`MAINTAINERS.md`](./MAINTAINERS.md)，新贡献者请先查阅
|
||||
[`CONTRIBUTING_CN.md`](./CONTRIBUTING_CN.md)。
|
||||
|
||||
### 安全
|
||||
|
||||
如发现安全漏洞，请按照 [`SECURITY.md`](./SECURITY.md) 中的流程进行报告。
|
||||
|
||||
### 感谢
|
||||
|
||||
如果没有 Envoy 和 Istio 的开源工作，Higress 就不可能实现，在这里向这两个项目献上最诚挚的敬意。
|
||||
@@ -252,6 +269,22 @@ K8s 下使用 Helm 部署等其他安装方式可以参考官网 [Quick Start
|
||||
|
||||
[](https://star-history.com/#alibaba/higress&Date)
|
||||
|
||||
---
|
||||
|
||||
## 云原生计算基金会（CNCF）
|
||||
|
||||
<a href="https://www.cncf.io/projects/" target="_blank">
|
||||
<img src="https://raw.githubusercontent.com/cncf/artwork/master/other/cncf/horizontal/color/cncf-color.svg" alt="Cloud Native Computing Foundation" width="300"/>
|
||||
</a>
|
||||
|
||||
Higress 是 [Cloud Native Computing Foundation](https://www.cncf.io/) 的沙箱（Sandbox）项目。
|
||||
|
||||
The Linux Foundation® (TLF) 拥有相关注册商标并对其加以使用。完整的 LF 商标清单见
|
||||
[Trademark Usage](https://www.linuxfoundation.org/legal/trademark-usage)。
|
||||
|
||||
Copyright Higress a Series of LF Projects, LLC. 项目相关的网站使用条款、商标策略及其他政策，
|
||||
请参见 [https://lfprojects.org/policies/](https://lfprojects.org/policies/)。
|
||||
|
||||
<p align="right" style="font-size: 14px; color: #555; margin-top: 20px;">
|
||||
<a href="#readme-top" style="text-decoration: none; color: #007bff; font-weight: bold;">
|
||||
↑ 返回顶部 ↑
|
||||
|
||||
Reference in New Issue
Block a user