mirror of https://github.com/OI-wiki/OI-wiki
feat: contributing (#4132)
* feat: contributing (previsional) * feat: codeowners * feat: chinese * fix: chinese grammer (unfixed in last commit) * Update contributing.md Co-authored-by: Wenzhuo Liu <mgt@oi-wiki.org> * Update contributing.md Co-authored-by: Marcythm <marcythm@gmail.com> * Update contributing.md Co-authored-by: Marcythm <marcythm@gmail.com> * Update contributing.md Co-authored-by: Coelacanthus <coelacanthus@outlook.com> * Update contributing.md * Update contributing.md * Update contributing.md * Update contributing.md Co-authored-by: Coelacanthus <coelacanthus@outlook.com> * Update contributing.md Co-authored-by: Coelacanthus <coelacanthus@outlook.com> * Update contributing.md Co-authored-by: Zhikai Zeng <44666321+Backl1ght@users.noreply.github.com> * Update contributing.md Co-authored-by: Zhikai Zeng <44666321+Backl1ght@users.noreply.github.com> * Update contributing.md Co-authored-by: Zhikai Zeng <44666321+Backl1ght@users.noreply.github.com> * Update contributing.md Co-authored-by: Coelacanthus <coelacanthus@outlook.com> * Update contributing.md * Update contributing.md Co-authored-by: Coelacanthus <coelacanthus@outlook.com> * fix: coc * Update CODE_OF_CONDUCT.md * fix: newline * Update CODE_OF_CONDUCT.md * Rename contributing.md to .github/contributing.md * Update CODEOWNERS * Delete CONTRIBUTING.md * Rename contributing.md to CONTRIBUTING.md * Update pull_request_template.md * Apply suggestions from code review * style: format markdown files with remark-lint * Apply suggestions from @Tiger3018 in Telegram * ref: htc * Apply suggestions * Update .github/CONTRIBUTING.md Co-authored-by: Xeonacid <i@xeonacid.xyz> * Update .github/CONTRIBUTING.md Co-authored-by: Xeonacid <i@xeonacid.xyz> * fix: no trans & bold * Update .github/CONTRIBUTING.md Co-authored-by: Tiger3018 <tiger3018of02@gmail.com> * Update pull_request_template.md changed B- tree to lambda because B&B- Tree mixes in this pr. Co-authored-by: Wenzhuo Liu <mgt@oi-wiki.org> Co-authored-by: Marcythm <marcythm@gmail.com> Co-authored-by: Coelacanthus <coelacanthus@outlook.com> Co-authored-by: Zhikai Zeng <44666321+Backl1ght@users.noreply.github.com> Co-authored-by: 24OI-bot <15963390+24OI-bot@users.noreply.github.com> Co-authored-by: Great-designer <63183399+Great-designer@users.noreply.github.com> Co-authored-by: Xeonacid <i@xeonacid.xyz> Co-authored-by: Tiger3018 <tiger3018of02@gmail.com>pull/4239/head
Shuzhou Liu
GitHub
parent
227b47d348
commit
a9e12b5b6a
|
|
@ -10,7 +10,7 @@
|
|||
.github/workflows/celebration.yml @ouuan
|
||||
.github/workflows/pr-stale.yml @CoelacanthusHex
|
||||
.github/ISSUE_TEMPLATE/ @Ir1d
|
||||
.github/CONTRIBUTING.md @Ir1d
|
||||
.github/CONTRIBUTING.md @Ir1d @shuzhouliu
|
||||
.github/FUNDING.yml @Ir1d
|
||||
Dockerfile @CoelacanthusHex
|
||||
docs/intro/docker-deploy.md @CoelacanthusHex
|
||||
|
|
|
|||
|
|
@ -1 +1,19 @@
|
|||
感谢您愿意为 **OI Wiki** 做出贡献！请阅读 [如何参与](https://oi-wiki.org/intro/htc/) 以了解更多~
|
||||
:+1::tada: 首先，感谢您抽出宝贵时间为 **OI Wiki** 做出贡献！ :tada::+1:
|
||||
|
||||
请您在提交拉取请求（Pull Request）前再次阅读[如何参与的有关内容](https://oi-wiki.org/intro/htc/)，尤其应再次确认**对于目录和引用的变更**和**信息格式规范**。
|
||||
|
||||
如果有关内容**尚未完成**，请考虑先新建 issue 或本次作为 draft pr 提交。
|
||||
|
||||
如果内容**已经完成**，您无需新建 issue ，但仍需要核对[格式手册](https://oi-wiki.org/intro/format/)中文档的基本格式要求。在机器人修改、测试构建完成后，建议您检查实际效果，并持续跟进审核或修改意见。
|
||||
|
||||
在提交 pull request 的[描述](.github/pull_request_template.md)中，勾选已阅读贡献指南，表明**您已知晓**：
|
||||
|
||||
+ 请在回应建议、问题或 pull request 之前仔细阅读，并详细说明自己的看法，以免引起不必要的误会。
|
||||
|
||||
+ 请跟进您的 pull request。如您的 pull request 长时间没有回应修改请求，可能会被直接关闭。
|
||||
|
||||
+ 我们欢迎您审核其他 pull request，但请以友好的方式发表评论。负面评论会打击社区贡献者的贡献热情，因此不建议这样做。当你在 pull request 中发现问题时，欢迎进一步的 pull request，但不欢迎你对贡献者（pull request 作者）发表负面评价。
|
||||
|
||||
+ 请记住，您在一个社区中，您需要学会接受其他人的贡献，以及他们贡献的内容，甚至可能和他们协作。如果您不同意这个观点，您可以创建分支并自己进行更改。另一方面，你的想法可能不够完善，所以要听取别人的意见。
|
||||
|
||||
最后，当您为社区做出贡献时，您亦同意 OI Wiki 组织可以禁止违反社区准则并破坏社区和谐的用户访问组织。如果您发现有人不遵守此处的指南，欢迎联系 [hi@oi-wiki.org](mailto:hi@oi-wiki.org)。感谢您为本项目及其社区和谐发展提供的支持和力量！:joy:
|
||||
|
|
|
|||
|
|
@ -1,19 +1,10 @@
|
|||
- [ ] 我已认真阅读贡献指南 (contributing guidelines) 和社区公约 (code of conduct)，并遵循了如何参与页及格式手册页的相应规范。
|
||||
|
||||
<!--
|
||||
首先，十分感谢您花时间来给 OI Wiki 开一个 Pull Request，下面是一些您可能需要知道的信息：
|
||||
|
||||
- 请在 Compare 页面仔细检查您的提交是否符合符合您的预期，例如您的修改是否波及到了其他文件，是否发生了意图之外的文件名修改（这在您启用了翻译软件的情况下较为常见），是否引入了无关文件。
|
||||
- 请在 commit 的时候写比较有意义的 commit message。
|
||||
- 请给 PR 起比较有意义的标题。
|
||||
- 如果您的 PR 可以解决某个现有的 issue，请在这个文本框的开头部分写上 fix + issue 编号。 如：fix #1622
|
||||
- 关于文档内容的基本格式和基本内容规范，可以查阅 [如何参与](https://oi-wiki.org/intro/htc)。
|
||||
- 请确保勾选了下方允许维护者修改的候选框（lint bot 需要在 PR 环节修正格式）
|
||||
|
||||
**如果有需要额外注明的内容，请写在这个文本框的开头部分 :smile: 谢谢～**
|
||||
这是 Pull Request 的描述页面，可拖动输入框右下角调节大小。尽管按下绿色按钮提交后，您仍可以对描述进行修改，但还请您先阅读以下注意事项。
|
||||
- 请不要删去本区域文字，或在此修改内容，因为本区域作为注释内容是不可见的。你应该点击 Preview 查看描述页效果。
|
||||
- 请勾选输入框外的 `Allow edits from maintainers` 的候选框（机器人需要修正格式），并通过蓝色高亮链接阅读、理解了指南和公约后，将上述 [ ] 替换为 [x]。
|
||||
- 请对照规范页面，检查 Commit 信息、PR 标题和下方 Compare 页面，例如：
|
||||
- 标题应类似于 `feat(lang/lambda.md): 增加使用对象描述` 。
|
||||
- 您的修改是否波及到了其他文件，是否发生了意图之外的文件名修改（这在您启用了翻译软件的情况下较为常见），是否引入了无关文件。
|
||||
-->
|
||||
|
||||
**审核的同学** 请着重关注以下四方面：
|
||||
|
||||
1. 注意有没有 typo
|
||||
2. 不论您是否熟悉相关知识，都请以初学者的角度把这个 PR 的内容阅读一遍，跟着作者的思路走，然后谈谈您的感受
|
||||
3. 如果您熟悉相关知识，请按照自己的理解评估这个 PR 的内容是否合适
|
||||
4. 请**尽量**保持跟进直到它被 merge 或 close
|
||||
|
|
|
|||
|
|
@ -1,75 +1,75 @@
|
|||
# Contributor Covenant Code of Conduct
|
||||
# 贡献者公约
|
||||
|
||||
## Our Pledge
|
||||
## 我们的承诺
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and maintainers pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, disability, ethnicity, sex characteristics, gender identity and expression,
|
||||
level of experience, education, socio-economic status, nationality, personal
|
||||
appearance, race, religion, or sexual identity and orientation.
|
||||
身为社区成员、贡献者和领袖，我们承诺使社区参与者不受骚扰，无论其年龄、体型、可见或不可见的缺陷、族裔、性征、性别认同和表达、经验水平、教育程度、社会与经济地位、国籍、相貌、种族、种姓、肤色、宗教信仰、性倾向或性取向如何。
|
||||
|
||||
## Our Standards
|
||||
我们承诺以有助于建立开放、友善、多样化、包容、健康社区的方式行事和互动。
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment
|
||||
include:
|
||||
## 我们的准则
|
||||
|
||||
- Using welcoming and inclusive language
|
||||
- Being respectful of differing viewpoints and experiences
|
||||
- Gracefully accepting constructive criticism
|
||||
- Focusing on what is best for the community
|
||||
- Showing empathy towards other community members
|
||||
有助于为我们的社区创造积极环境的行为例子包括但不限于：
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
+ 表现出对他人的同情和善意
|
||||
|
||||
- The use of sexualized language or imagery and unwelcome sexual attention or
|
||||
advances
|
||||
- Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
- Public or private harassment
|
||||
- Publishing others' private information, such as a physical or electronic
|
||||
address, without explicit permission
|
||||
- Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
+ 尊重不同的主张、观点和感受
|
||||
|
||||
## Our Responsibilities
|
||||
+ 提出和大方接受建设性意见
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable
|
||||
behavior and are expected to take appropriate and fair corrective action in
|
||||
response to any instances of unacceptable behavior.
|
||||
+ 承担责任并向受我们错误影响的人道歉
|
||||
|
||||
Project maintainers 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, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
+ 注重社区共同诉求，而非个人得失
|
||||
|
||||
## Scope
|
||||
不当行为例子包括：
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community. Examples of
|
||||
representing a project or community include using an official project e-mail
|
||||
address, posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event. Representation of a project may be
|
||||
further defined and clarified by project maintainers.
|
||||
+ 使用情色化的语言或图像，及性引诱或挑逗
|
||||
+ 嘲弄、侮辱或诋毁性评论，以及人身或政治攻击
|
||||
+ 公开或私下的骚扰行为
|
||||
+ 未经他人明确许可，公布他人的私人信息，如物理或电子邮件地址
|
||||
+ 其他有理由认定为违反职业操守的不当行为
|
||||
|
||||
## Enforcement
|
||||
## 责任和权力
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project team at [hi@oi-wiki.org.](mailto:hi@oi-wiki.org.) All
|
||||
complaints will be reviewed and investigated and will result in a response that
|
||||
is deemed necessary and appropriate to the circumstances. The project team is
|
||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||
Further details of specific enforcement policies may be posted separately.
|
||||
社区领袖有责任解释和落实我们所认可的行为准则，并妥善公正地对他们认为不当、威胁、冒犯或有害的任何行为采取纠正措施。
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||
faith may face temporary or permanent repercussions as determined by other
|
||||
members of the project's leadership.
|
||||
社区领导有权力和责任删除、编辑或拒绝或拒绝与本行为准则不相符的评论（comment）、提交（commits）、代码、维基（wiki）编辑、议题（issues）或其他贡献，并在适当时机知采取措施的理由。
|
||||
|
||||
## Attribution
|
||||
## 适用范围
|
||||
|
||||
This Code of Conduct is adapted from the[Contributor Covenant][homepage], version 1.4,
|
||||
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
|
||||
本行为准则适用于所有社区场合，也适用于在公共场所代表社区时的个人。
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
代表社区的情形包括使用官方电子邮件地址、通过官方社交媒体帐户发帖或在线上或线下活动中担任指定代表。
|
||||
|
||||
For answers to common questions about this code of conduct, see <https://www.contributor-covenant.org/faq>
|
||||
### 监督
|
||||
|
||||
辱骂、骚扰或其他不可接受的行为可通过 [hi@oi-wiki.org](mailto:hi@oi-wiki.org) 向负责监督的社区领袖报告。 所有投诉都将得到及时和公平的审查和调查。
|
||||
|
||||
所有社区领袖都有义务尊重任何事件报告者的隐私和安全。
|
||||
|
||||
### 处理方针
|
||||
|
||||
社区领袖将遵循下列社区处理方针来明确他们所认定违反本行为准则的行为的处理方式：
|
||||
|
||||
1. 纠正
|
||||
|
||||
社区影响：使用不恰当的语言或其他在社区中被认定为不符合职业道德或不受欢迎的行为。
|
||||
|
||||
处理意见：由社区领袖发出非公开的书面警告，明确说明违规行为的性质，并解释举止如何不妥。或将要求公开道歉。
|
||||
|
||||
2. 警告
|
||||
|
||||
社区影响：单个或一系列违规行为。
|
||||
|
||||
处理意见：警告并对连续性行为进行处理。在指定时间内，不得与相关人员互动，包括主动与行为准则执行者互动。这包括避免在社区场所和外部渠道中的互动。违反这些条款可能会导致临时或永久封禁。
|
||||
|
||||
3. 临时封禁
|
||||
|
||||
社区影响: 严重违反社区准则，包括持续的不当行为。
|
||||
|
||||
处理意见: 在指定时间内，暂时禁止与社区进行任何形式的互动或公开交流。在此期间，不得与相关人员进行公开或私下互动，包括主动与行为准则执行者互动。违反这些条款可能会导致永久封禁。
|
||||
|
||||
4. 永久封禁
|
||||
|
||||
社区影响：行为模式表现出违反社区准则，包括持续的不当行为、骚扰个人或攻击或贬低某个类别的个体。
|
||||
|
||||
处理意见：永久禁止在社区内进行任何形式的公开互动。
|
||||
|
|
|
|||
|
|
@ -2,6 +2,10 @@
|
|||
|
||||
这篇文章将主要叙述参与 **OI Wiki** 编写的写作过程。请您在撰稿或者修正 Wiki 页面以前，仔细阅读以下内容，以帮助您完成更高质量的内容。
|
||||
|
||||
## 贡献指南
|
||||
|
||||
请您在编辑前查看 [OI Wiki 贡献指南](https://github.com/OI-wiki/OI-wiki/blob/master/.github/CONTRIBUTING.md)，以更好地和社区贡献者进行合作、交流。
|
||||
|
||||
## 参与协作
|
||||
|
||||
???+ warning
|
||||
|
|
|
|||
Loading…
Reference in New Issue