Skip to content

Commit 549810c

Browse files
committed
First round revision of the project README
1 parent 9dafe3a commit 549810c

12 files changed

Lines changed: 278 additions & 181 deletions

CODE_OF_CONDUCT.md

Lines changed: 32 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
## Our Pledge
44

5-
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone,
6+
regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression,
7+
level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion,
8+
or sexual identity and orientation.
69

710
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
811

@@ -26,55 +29,72 @@ Examples of unacceptable behavior include:
2629

2730
## Enforcement Responsibilities
2831

29-
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
32+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate
33+
and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
3034

31-
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
35+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues,
36+
and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions
37+
when appropriate.
3238

3339
## Scope
3440

35-
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
41+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces.
42+
Examples of representing our community include using an official e-mail address, posting via an official social media account,
43+
or acting as an appointed representative at an online or offline event.
3644

3745
## Enforcement
3846

39-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement in the WeChat Group. All complaints will be reviewed and investigated promptly and fairly.
47+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement
48+
in the WeChat Group. All complaints will be reviewed and investigated promptly and fairly.
4049

4150
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
4251

4352
## Enforcement Guidelines
4453

45-
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
54+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action
55+
they deem in violation of this Code of Conduct:
4656

4757
### 1. Correction
4858

4959
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
5060

51-
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
61+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation
62+
and an explanation of why the behavior was inappropriate. A public apology may be requested.
5263

5364
### 2. Warning
5465

5566
**Community Impact**: A violation through a single incident or series of actions.
5667

57-
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
68+
**Consequence**: A warning with consequences for continued behavior.
69+
No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct,
70+
for a specified period of time.
71+
This includes avoiding interactions in community spaces as well as external channels like social media.
72+
Violating these terms may lead to a temporary or permanent ban.
5873

5974
### 3. Temporary Ban
6075

6176
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
6277

63-
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
78+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time.
79+
No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct,
80+
is allowed during this period. Violating these terms may lead to a permanent ban.
6481

6582
### 4. Permanent Ban
6683

67-
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
84+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,
85+
harassment of an individual, or aggression toward or disparagement of classes of individuals.
6886

6987
**Consequence**: A permanent ban from any sort of public interaction within the community.
7088

7189
## Attribution
7290

73-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
91+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at
92+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
7493

7594
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
7695

77-
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
96+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ].
97+
Translations are available at [https://www.contributor-covenant.org/translations][translations].
7898

7999
[homepage]: https://www.contributor-covenant.org
80100
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

CONTRIBUTING.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
# FlagGems Contributor's Guide
44

5-
Thank you for your interest in FlagGems! We use github to host code, manage issues and pull requests. Before contributing, please read the following guidelines.
5+
Thank you for your interest in FlagGems! We use github to host code, manage issues and pull requests.
6+
Before contributing, please read the following guidelines.
67

78
## 1. Bug Report
89

@@ -16,13 +17,15 @@ Please report bugs using Github's issues. When reporting bugs, please provide
1617
## 2. Code Contribution
1718

1819
In pull requests, contributor should describe what changed and why. Please also provide test cases if applicable.
19-
Pull requests require approvals from **one member** before merging. Additionally, they must pass continuous integration checks. More details see [Code Contribution](docs/code_countribution.md)
20+
Pull requests require approvals from **one member** before merging.
21+
Additionally, they must pass continuous integration checks. More details see [Code Contribution](./docs/contribution.md)
2022

2123
Currently, continuous integration checks include four pipelines:
2224

2325
## 3. Documentation Supplement
2426

25-
The documentation for FlagGems is stored in the `docs` directory and is currently built and deployed using [MkDocs](https://www.mkdocs.org/). The documentation undergoes nightly builds in the CI pipeline.
27+
The documentation for FlagGems is stored in the `docs` directory and is currently built and deployed using [MkDocs](https://www.mkdocs.org/).
28+
The documentation undergoes nightly builds in the CI pipeline.
2629

2730
# Project Structure
2831

@@ -54,4 +57,4 @@ FlagGems
5457

5558
# License
5659

57-
Any contributions you make will be under the [Apache License](https://github.com/FlagOpen/FlagGems/blob/master/LICENSE).
60+
Any contributions you make will be under the [Apache License (Version 2.0)](./LICENSE).

CONTRIBUTING_cn.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,10 @@
1515

1616
## 2. 代码贡献
1717

18-
在提交拉取请求时,贡献者应描述所做的更改以及更改的原因。如果可以设计测试用例,请提供相应测试。拉取请求在合并前需要 **一位** 成员的批准,而且需要通过代码的持续集成检查。 详细信息见 [代码贡献指南](docs/code_countribution.md)
18+
在提交拉取请求时,贡献者应描述所做的更改以及更改的原因。
19+
如果可以设计测试用例,请提供相应测试。拉取请求在合并前需要 **一位** 成员的批准,
20+
而且需要通过代码的持续集成检查。
21+
详细信息见 [代码贡献指南](./docs/contribution.md)
1922

2023
## 3. 文档补充
2124

@@ -51,4 +54,4 @@ FlagGems
5154

5255
# FlagGems 许可证
5356

54-
FlagGems 使用 [Apache 许可证](https://github.com/FlagOpen/FlagGems/blob/master/LICENSE)
57+
FlagGems 使用 [Apache License (Version 2.0)](./LICENSE) 许可证。

0 commit comments

Comments
 (0)