Skip to content

Commit

Permalink
docs: update CONTRIBUTING.md, and add docs (#11)
Browse files Browse the repository at this point in the history
- Code-Of-Conduct.md
- CONTRIBUTE.md
  • Loading branch information
liuzengh authored Aug 23, 2023
1 parent 6dfc820 commit bbfd46a
Show file tree
Hide file tree
Showing 3 changed files with 391 additions and 76 deletions.
102 changes: 102 additions & 0 deletions CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# Community Code of Conduct

Welcome to our open source project!

We are committed to creating a friendly, respectful, and inclusive community.
To ensure a positive experience in our project, we have established the following code of conduct, which we require all participants to abide by, and provide a safe and inclusive environment for all community members.

## Our Pledge

As participants, contributors, and maintainers of our community, we pledge to:
- Treat everyone with openness, inclusivity, and collaboration;
- Respect individuals with different backgrounds and viewpoints, regardless of gender, sexual orientation, disability, race, ethnicity, religion, age, or any other factor;
- Focus on contributing and improving the project, rather than attacking or criticizing individuals;
- Build trust with community members and promote our project through constructive feedback;
- Provide a safe, supportive, and encouraging environment for community members to promote learning and personal growth.

## Our standards

Our community members should adhere to the following standards:
- Respect the opinions, viewpoints, and experiences of others;
- Avoid using insulting, discriminatory, or harmful language;
- Do not harass, intimidate, or threaten others;
- Do not publicly or privately disclose others' private information, such as contact information or addresses;
- Respect the privacy of others;
- Establish a safe, inclusive, and respectful environment for community members.

## Our responsibility

Project maintainers have a responsibility to create a friendly, respectful, and inclusive environment for our community members.
They should:
- Clearly and publicly explain the community guidelines;
- Handle reports of guideline violations and resolve disputes appropriately;
- Protect the privacy and security of all community members;
- Maintain a fair, transparent, and responsible attitude.


## Scope

This code of conduct applies to all project spaces, including GitHub, mailing lists, forums, social media, gatherings, and conferences.
Violations of the code of conduct will be dealt with, including but not limited to warnings, temporary or permanent bans, revocation of contribution rights, and revocation of project access rights.

## Implementation guidelines

If you encounter behavior that violates this code of conduct, you can:
- Communicate privately with the relevant person to try to resolve the issue;
- Report the violation to the project maintainers(maintainer mailing list), who will take necessary action based on the situation;
- If you are not satisfied with the way the maintainers handle the situation, you can seek help from higher-level organizations or institutions.

Our community is a diverse, open, and inclusive community, and we welcome everyone's participation and contribution.
We believe that only in a safe, respectful, and inclusive environment can we create the best project together.

---

# 社区行为准则

欢迎来到我们的开源项目!

我们致力于创建一个友好、尊重和包容的社区,我们希望所有人都能为此做出贡献。
为了确保在我们的项目中有一个积极的体验,我们制定了以下行为准则,我们要求所有参与者遵守这些准则,并向所有社区成员提供一个安全和包容的环境。

## 我们的承诺

作为我们社区的参与者、贡献者和维护者,我们承诺:
- 以开放、包容和合作的态度对待所有人;
- 尊重不同背景和观点的人,不论是性别、性取向、残疾、种族、民族、宗教、年龄或任何其他因素;
- 专注于对项目的贡献和改进,而不是对个人的攻击或抨击;
- 与社区成员建立互信关系,通过积极的反馈来推动我们的项目发展;
- 为社区成员提供一个安全、支持和鼓励的环境,以促进学习和个人成长。

## 我们的标准

我们的社区成员应该遵守以下标准:
- 尊重他人的意见、观点和经验;
- 避免使用侮辱性、歧视性或有损的语言;
- 不要骚扰、恐吓或威胁他人;
- 不要公开或私下发布他人的私人信息,例如联系方式或地址;
- 尊重他人的隐私权;
- 为社区成员建立安全、包容和尊重的环境。

## 我们的责任

项目维护者有责任为我们的社区成员创造一个友好、尊重和包容的环境。
他们应该:
- 明确和公开地说明社区准则;
- 处理准则违规行为的举报,通过适当的方式解决纠纷;
- 保护所有社区成员的隐私和安全;
- 保持公正、透明和负责任的态度。

## 管理范围

本行为准则适用于所有的项目空间,包括GitHub、邮件列表、论坛、社交媒体、聚会和会议等。
违反准则的行为将受到处理,包括但不限于警告、暂时或永久禁言、撤销贡献权、撤销项目访问权等。

## 实施指南

如果你遇到了违反本准则的行为,你可以:
- 私下与相关人员沟通,以尝试解决问题;
- 向项目维护者报告违规行为,维护者会根据情况采取必要的行动;
- 如果你不满意维护者的处理方式,你可以向更高级别的机构或组织寻求帮助。

我们的社区是一个多样化、开放和包容的社区,我们欢迎所有人的参与和贡献。
我们相信,只有在一个安全、尊重和包容的环境中,我们才能共同创造出最优秀的项目。
Loading

0 comments on commit bbfd46a

Please sign in to comment.