Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GSoD 2021] Improved contributing guidelines #1276

Merged
merged 15 commits into from
Sep 18, 2021
2 changes: 1 addition & 1 deletion docusaurus/docs/contributing/blog.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ This is based on ImageMagick.

Submit your blog by creating a Pull Request at <https://github.com/wechaty/wechaty.js.org/tree/master/jekyll/_posts>

Please make sure the CI turns green, and if the CI fail, you need to check the error messages and fix all the problems before we can continue processing it.
Please make sure the CI turns green, and if the CI fails, you need to check the error messages and fix all the problems before we can continue processing it.

## Support

Expand Down
78 changes: 78 additions & 0 deletions docusaurus/docs/contributing/code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
title: Wechaty Community Code of Conduct
---

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make 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 within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
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 [INSERT EMAIL ADDRESS]. 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.

## 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>
12 changes: 6 additions & 6 deletions docusaurus/docs/contributing/contributor-program.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ sidebar_label: Contributor program

The _Wechaty Contributor Program_ provides valuable supports for qualified contributors.

> Our Mission: build the most easy to use conversational SDK across all messaging platforms for chatbot makers.
> Our Mission: build the most easy-to-use conversational SDK across all messaging platforms for chatbot makers.
It takes a community to design, build, and ship great chatbot.
It takes a community to design, build, and ship a great chatbot.

Building an chatbot that on top of Wechaty? Apply for our Contributor Program! The possibilities are endless, and you enjoy the kudos.
Building a chatbot that is on top of Wechaty? Apply for our Contributor Program! The possibilities are endless, and you enjoy the kudos.

## Table of Contents

Expand All @@ -29,7 +29,7 @@ Learn more about Wechaty Puppet Services from our [document](../puppet-services/

## 2. Support the Wechaty Project

You can help the project by supporting this project as becoming a backer. [![Backers on Open Collective](https://opencollective.com/wechaty/backers/badge.svg)](#backers)
You can help the project by supporting this project as becoming a backer. [![Backers on Open Collective](https://opencollective.com/wechaty/backers/badge.svg)](#backers)

The following are our existing backers. Thank you to everyone! 🙏 [[Become a backer](https://opencollective.com/wechaty#backer)]

Expand All @@ -39,7 +39,7 @@ The following are our existing backers. Thank you to everyone! 🙏 [[Become a b

[![Wechaty Contributor Program](https://img.shields.io/badge/Wechaty-Contributor%20Program-green.svg)](https://wechaty.js.org/docs/contributing/)

You need to add the __Wechaty Contributor Program__ badge after you join this program.
You need to add the **Wechaty Contributor Program** badge after you join this program.

```md
[![Wechaty Contributor Program](https://img.shields.io/badge/Wechaty-Contributor%20Program-green.svg)](https://wechaty.js.org/docs/contributing/)
Expand Down Expand Up @@ -82,7 +82,7 @@ Add this Wechaty badge to your README:

Then add it to the list at [Project using Wechaty](http://wechaty.js.org/docs/case-study/projects-using-wechaty)

## Third Party Supports for Wechaty Contributors
## Third-Party Supports for Wechaty Contributors

### Juzi.BOT

Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/contributing/devops.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ To-be-added. (Pull Request is welcome!)

## Blog

- [Wonderful Wechaty devops toolset, @windmemory, Jun 20, 2020](https://wechaty.js.org/2020/06/20/wonderful-wechaty-devops-tools/)
- [Wonderful Wechaty DevOps toolset, @windmemory, Jun 20, 2020](https://wechaty.js.org/2020/06/20/wonderful-wechaty-devops-tools/)
Loading