JooKS-me commented on a change in pull request #488:
URL:
https://github.com/apache/incubator-shenyu-website/pull/488#discussion_r830484685
##########
File path: community/3-contributor.md
##########
@@ -1,107 +1,149 @@
---
-title: Contributor
-sidebar_position: 4
+id: contributor-guide
+title: Contributor Guide
+sidebar_position: 3
description: Apache ShenYu Contributor's Guide
-author: "xiaoyu"
categories: "Apache ShenYu"
tags: ["Contributor"]
-date: 2019-04-09
-cover: "/img/architecture/shenyu-framework.png"
---
+We welcome every contributor to join us!
-You can report a bug, submit a new function enhancement suggestion, or submit
a pull request directly.
+### Kinds of Contributions
-## Submit an Issue {#submit-an-issue}
+In the Apache ShenYu community, there are many ways to contribute:
-- Before submitting an issue, please go through a comprehensive search to make
sure the problem cannot be solved just by searching.
-- Check the [Issue List](https://github.com/apache/incubator-shenyu/issues) to
make sure the problem is not repeated.
-- [Create](https://github.com/apache/incubator-shenyu/issues/new/choose) a new
issue and choose the type of issue.
-- Define the issue with a clear and descriptive title.
-- Fill in necessary information according to the template.
-- Choose a label after the issue is created, for example:
bug，enhancement，discussion.
-- Please pay attention to your issue, you may need to provide more information
during discussion.
+Code: Can help the community complete some tasks, write new features or fix
some bugs;
-## Developer Flow {#developer-flow}
+Test: Can come to participate in the writing of test code, including unit
testing, integration testing, e2e testing;
-**Fork ShenYu repo**
+Docs: Can write or Documentation improved to help users better understand and
use Apache ShenYu;
-- Fork a `Apache ShenYu` repo to your own repo to work, then setting upstream.
+Blog: You can write articles about Apache ShenYu to help the community better
promote;
-* git clone from your repository.
+Discussion: You can participate in the discussion of new features of Apache
ShenYu and integrate your ideas with Apache ShenYu;
-```shell
-git clone https://github.com/your-github/incubator-shenyu.git
-```
+Preach: Can help publicize or promote the Apache ShenYu community, speak in
meetup or summit;
- if you have some problem about filename too long when cloning source code
in windows enviroment，please see [FAQ](/community/faq)
+Suggestion: You can also make some suggestions to the project or community to
promote the healthy development of the community;
-* set remote repository (To synchronize remote repository updates) .
+. . .
-```shell
-git remote add apache https://github.com/apache/incubator-shenyu.git
-```
+Even minor corrections to typos, or corrections to 404 links, are very welcome
:)
-**Choose or Creator Issue**
+### Join the Discussion
-- Please choose the issue to be edited. If it is a new issue discovered or a
new function enhancement to offer, please create an issue and set the right
label for it.
-- After choosing the relevant issue, please reply with a deadline to indicate
that you are working on it.
+We believe: [Community Over
Code](https://www.apache.org/theapacheway/index.html).
-**Create Branch**
+Participating in discussions is the first step in contributing, please
subscribe to our mailing list first and participate in ongoing discussions on
the mailing list!
-- Switch to forked master branch, pull codes from upstream, then create a new
branch.
+The steps to subscribe to emails are simple:
-```shell
-git checkout master
-git pull apche master
-git checkout -b issueNo
-```
+1. Send an email to
[[email protected]](mailto:[email protected]);
+2. After sending successfully, you will receive a reply from
[[email protected]](mailto:[email protected]), please reply
to this email according to the instructions of the email to confirm the
subscription ;
+3. After replying to confirm, you will receive a welcome email indicating that
you have successfully subscribed to the email.
+
+After the subscription is successful, you can participate in the discussion at
[[email protected]](mailto:[email protected]). You can also click on
[Public Archives](https://lists.apache.org/[email protected]) to
see historical emails.
+
+During the discussion, please be polite and suggest reading [Code of
Conduct](https://www.apache.org/foundation/policies/conduct.html) of ASF.
+
+### Target Repository
+
+Apache ShenYu is generally developed collaboratively on GitHub. Currently,
there are the following repositories:
+
+| REPOSITORY | DESCRIPTION
|
+| ------------------------------------------------------------ |
------------------------------ |
+| [apache/incubator-shenyu](https://github.com/apache/incubator-shenyu) | Main
Repository |
+|
[apache/incubator-shenyu-dashboard](https://github.com/apache/incubator-shenyu-dashboard)
| Front-end Code of shenyu-admin |
+|
[apache/incubator-shenyu-website](https://github.com/apache/incubator-shenyu-website)
| Official Website and Documents |
+|
[apache/incubator-shenyu-sdk](https://github.com/apache/incubator-shenyu-sdk) |
Multilingual SDK |
+|
[apache/incubator-shenyu-nginx](https://github.com/apache/incubator-shenyu-nginx)
| Code to integrate with nginx |
Review comment:
Hi folks, suggestions can be made about the description of the repo.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
