You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/02/21 06:05:44 UTC
[GitHub] [apisix-website] yzeng25 commented on a change in pull request #893: fix: update "General" docs
yzeng25 commented on a change in pull request #893:
URL: https://github.com/apache/apisix-website/pull/893#discussion_r810792417
##########
File path: website/docs/general/committer-guide.md
##########
@@ -6,68 +6,70 @@ keywords:
- APISIX
- Apache APISIX
- committer guide
-description: This article is a set of guidelines for Apache APISIX committers. It provides general guideline of contritions, and the way of promoting from contributors to commiter, and from committer to PMC.
+description: This article covers some guidelines for Apache APISIX committers. It walks through the type of contributions and the contributor ladder and how contributors can become committers and then PMC members.
---
-## What can I contribute?
+This article walks through the guidelines for Apache APISIX contributors.
-All forms of contributions are accepted, for example:
+See [Contributor Guide](/docs/general/contributor-guide/) to learn more about the contributing process.
-1. Take a look at issues with tag called Good first issue or Help wanted.
+## What Can I Contribute?
-2. Join the discussion on mailing list.
+Any and all forms of contributions are welcome! For example you can,
-3. Answer questions on issues.
+- Fix issues tagged "[good first issue](/docs/general/contributor-guide/#good-first-issues)" or "[help wanted](https://github.com/apache/apisix/issues?q=is%3Aopen+label%3A%22help+wanted%22+sort%3Aupdated-desc)".
-4. Fix bugs reported on issues, and send us pull request.
+- Join the discussions on the [mailing list](/docs/general/subscribe-guide/).
-5. Review the existing pull request.
+- Answer questions in [issues](https://github.com/apache/apisix/issues) and [discussions](https://github.com/apache/apisix/discussions).
-6. Improve the website.
+- Review open [pull requests](https://github.com/apache/apisix/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc).
-7. Write a document or article.
+- Improve the website.
-8. Any form of contribution that is not mentioned above.
+- Improve documentation or write a blog post.
-If you would like to contribute, please send an email to dev@apisix.apache.org to let us know!
+- Any other form of code or non-code contribution.
+
+If you would like to contribute, let us know by sending an email to dev@apisix.apache.org!
## How to become an APISIX committer?
-Anyone can be a contributor to an Apache project. Being a contributor simply means that you take an interest in the project and contribute in some way, ranging from asking sensible questions (which documents the project and provides feedback to developers) through to providing new features as patches.
+Anyone can be a contributor to an Apache project. Being a contributor means that you take an interest in the project and contribute to it in some way, ranging from asking sensible questions (which documents the project and provides feedback to developers) to working on new features and patches.
-If you become a valuable contributor to the project you may well be invited to become a committer. Committer is a term used at the ASF to signify someone who is committed to a particular project. It brings with it the privilege of write access to the project repository and resources.
+If you become a valuable contributor to the project you may be invited to become a Committer. A Committer is a term used at the ASF to signify someone who is committed to a particular project. It brings with it the privilege of write access to the project repository and resources.
More details could be found [here](https://community.apache.org/contributors/).
## Promotion
-The Apache APISIX community follows the Apache Community’s process on accepting a new committer. After a contributor participates in APISIX's community actively, (P)PMC and Committers will make decisions to invite the contributor join Committers and (P)PMC.
-
-Processes are:
+The Apache APISIX community follows the Apache Community’s process on accepting a new committer. After a contributor participates in APISIX's community actively, (P)PMC and Committers will decide whether to invite the contributor to join Committers and (P)PMC.
-1. Start the discussion and vote in @private. Only current PMC member could nominate
+1. This process starts with a discussion and vote in @private. Only the current PMC members can nominate a new committer or a PMC member.
Review comment:
```suggestion
1. This process starts with a discussion and vote in @private channel, where the current PMC members can nominate a new committer or a PMC member. Each new email in the discussion will extend the discussion for 72 hours. Please be patient while waiting for PMC members making their decision as a whole.
```
##########
File path: website/docs/general/committer-guide.md
##########
@@ -6,68 +6,70 @@ keywords:
- APISIX
- Apache APISIX
- committer guide
-description: This article is a set of guidelines for Apache APISIX committers. It provides general guideline of contritions, and the way of promoting from contributors to commiter, and from committer to PMC.
+description: This article covers some guidelines for Apache APISIX committers. It walks through the type of contributions and the contributor ladder and how contributors can become committers and then PMC members.
---
-## What can I contribute?
+This article walks through the guidelines for Apache APISIX contributors.
-All forms of contributions are accepted, for example:
+See [Contributor Guide](/docs/general/contributor-guide/) to learn more about the contributing process.
-1. Take a look at issues with tag called Good first issue or Help wanted.
+## What Can I Contribute?
-2. Join the discussion on mailing list.
+Any and all forms of contributions are welcome! For example you can,
-3. Answer questions on issues.
+- Fix issues tagged "[good first issue](/docs/general/contributor-guide/#good-first-issues)" or "[help wanted](https://github.com/apache/apisix/issues?q=is%3Aopen+label%3A%22help+wanted%22+sort%3Aupdated-desc)".
-4. Fix bugs reported on issues, and send us pull request.
+- Join the discussions on the [mailing list](/docs/general/subscribe-guide/).
-5. Review the existing pull request.
+- Answer questions in [issues](https://github.com/apache/apisix/issues) and [discussions](https://github.com/apache/apisix/discussions).
-6. Improve the website.
+- Review open [pull requests](https://github.com/apache/apisix/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc).
-7. Write a document or article.
+- Improve the website.
-8. Any form of contribution that is not mentioned above.
+- Improve documentation or write a blog post.
-If you would like to contribute, please send an email to dev@apisix.apache.org to let us know!
+- Any other form of code or non-code contribution.
+
+If you would like to contribute, let us know by sending an email to dev@apisix.apache.org!
## How to become an APISIX committer?
-Anyone can be a contributor to an Apache project. Being a contributor simply means that you take an interest in the project and contribute in some way, ranging from asking sensible questions (which documents the project and provides feedback to developers) through to providing new features as patches.
+Anyone can be a contributor to an Apache project. Being a contributor means that you take an interest in the project and contribute to it in some way, ranging from asking sensible questions (which documents the project and provides feedback to developers) to working on new features and patches.
-If you become a valuable contributor to the project you may well be invited to become a committer. Committer is a term used at the ASF to signify someone who is committed to a particular project. It brings with it the privilege of write access to the project repository and resources.
+If you become a valuable contributor to the project you may be invited to become a Committer. A Committer is a term used at the ASF to signify someone who is committed to a particular project. It brings with it the privilege of write access to the project repository and resources.
More details could be found [here](https://community.apache.org/contributors/).
## Promotion
-The Apache APISIX community follows the Apache Community’s process on accepting a new committer. After a contributor participates in APISIX's community actively, (P)PMC and Committers will make decisions to invite the contributor join Committers and (P)PMC.
-
-Processes are:
+The Apache APISIX community follows the Apache Community’s process on accepting a new committer. After a contributor participates in APISIX's community actively, (P)PMC and Committers will decide whether to invite the contributor to join Committers and (P)PMC.
-1. Start the discussion and vote in @private. Only current PMC member could nominate
+1. This process starts with a discussion and vote in @private. Only the current PMC members can nominate a new committer or a PMC member.
-2. If the vote passes, send an offer to become a committer with @private CC’ed
+2. If the vote passes, an offer letter is sent to the contributor to become a committer with @private CC’ed.
-3. New committer signs ICLA and apply Apache ID and email address
+3. The new committer can then sign the ICLA and apply for an Apache ID and email address.
Review comment:
Might as well add a link to the actual ICLA form.
```suggestion
3. The new committer can then sign the [ICLA](https://www.apache.org/licenses/contributor-agreements.html#clas) and apply for an Apache ID and email address.
```
##########
File path: website/docs/general/committer-guide.md
##########
@@ -6,68 +6,70 @@ keywords:
- APISIX
- Apache APISIX
- committer guide
-description: This article is a set of guidelines for Apache APISIX committers. It provides general guideline of contritions, and the way of promoting from contributors to commiter, and from committer to PMC.
+description: This article covers some guidelines for Apache APISIX committers. It walks through the type of contributions and the contributor ladder and how contributors can become committers and then PMC members.
---
-## What can I contribute?
+This article walks through the guidelines for Apache APISIX contributors.
-All forms of contributions are accepted, for example:
+See [Contributor Guide](/docs/general/contributor-guide/) to learn more about the contributing process.
-1. Take a look at issues with tag called Good first issue or Help wanted.
+## What Can I Contribute?
-2. Join the discussion on mailing list.
+Any and all forms of contributions are welcome! For example you can,
-3. Answer questions on issues.
+- Fix issues tagged "[good first issue](/docs/general/contributor-guide/#good-first-issues)" or "[help wanted](https://github.com/apache/apisix/issues?q=is%3Aopen+label%3A%22help+wanted%22+sort%3Aupdated-desc)".
-4. Fix bugs reported on issues, and send us pull request.
+- Join the discussions on the [mailing list](/docs/general/subscribe-guide/).
-5. Review the existing pull request.
+- Answer questions in [issues](https://github.com/apache/apisix/issues) and [discussions](https://github.com/apache/apisix/discussions).
-6. Improve the website.
+- Review open [pull requests](https://github.com/apache/apisix/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc).
-7. Write a document or article.
+- Improve the website.
-8. Any form of contribution that is not mentioned above.
+- Improve documentation or write a blog post.
-If you would like to contribute, please send an email to dev@apisix.apache.org to let us know!
+- Any other form of code or non-code contribution.
+
+If you would like to contribute, let us know by sending an email to dev@apisix.apache.org!
## How to become an APISIX committer?
-Anyone can be a contributor to an Apache project. Being a contributor simply means that you take an interest in the project and contribute in some way, ranging from asking sensible questions (which documents the project and provides feedback to developers) through to providing new features as patches.
+Anyone can be a contributor to an Apache project. Being a contributor means that you take an interest in the project and contribute to it in some way, ranging from asking sensible questions (which documents the project and provides feedback to developers) to working on new features and patches.
-If you become a valuable contributor to the project you may well be invited to become a committer. Committer is a term used at the ASF to signify someone who is committed to a particular project. It brings with it the privilege of write access to the project repository and resources.
+If you become a valuable contributor to the project you may be invited to become a Committer. A Committer is a term used at the ASF to signify someone who is committed to a particular project. It brings with it the privilege of write access to the project repository and resources.
More details could be found [here](https://community.apache.org/contributors/).
## Promotion
-The Apache APISIX community follows the Apache Community’s process on accepting a new committer. After a contributor participates in APISIX's community actively, (P)PMC and Committers will make decisions to invite the contributor join Committers and (P)PMC.
-
-Processes are:
+The Apache APISIX community follows the Apache Community’s process on accepting a new committer. After a contributor participates in APISIX's community actively, (P)PMC and Committers will decide whether to invite the contributor to join Committers and (P)PMC.
Review comment:
Actually the PMCs will go through a voting process after the nomination process, in which the PMCs will decide whether to invite this particular contributor to join as a Committer.
This has rarely anything to do with other Committers ( i.e. other Committers are not in any of the nominating, voting, or inviting process).
##########
File path: website/docs/general/committer-guide.md
##########
@@ -6,68 +6,70 @@ keywords:
- APISIX
- Apache APISIX
- committer guide
-description: This article is a set of guidelines for Apache APISIX committers. It provides general guideline of contritions, and the way of promoting from contributors to commiter, and from committer to PMC.
+description: This article covers some guidelines for Apache APISIX committers. It walks through the type of contributions and the contributor ladder and how contributors can become committers and then PMC members.
---
-## What can I contribute?
+This article walks through the guidelines for Apache APISIX contributors.
-All forms of contributions are accepted, for example:
+See [Contributor Guide](/docs/general/contributor-guide/) to learn more about the contributing process.
-1. Take a look at issues with tag called Good first issue or Help wanted.
+## What Can I Contribute?
-2. Join the discussion on mailing list.
+Any and all forms of contributions are welcome! For example you can,
-3. Answer questions on issues.
+- Fix issues tagged "[good first issue](/docs/general/contributor-guide/#good-first-issues)" or "[help wanted](https://github.com/apache/apisix/issues?q=is%3Aopen+label%3A%22help+wanted%22+sort%3Aupdated-desc)".
-4. Fix bugs reported on issues, and send us pull request.
+- Join the discussions on the [mailing list](/docs/general/subscribe-guide/).
-5. Review the existing pull request.
+- Answer questions in [issues](https://github.com/apache/apisix/issues) and [discussions](https://github.com/apache/apisix/discussions).
-6. Improve the website.
+- Review open [pull requests](https://github.com/apache/apisix/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc).
-7. Write a document or article.
+- Improve the website.
-8. Any form of contribution that is not mentioned above.
+- Improve documentation or write a blog post.
-If you would like to contribute, please send an email to dev@apisix.apache.org to let us know!
+- Any other form of code or non-code contribution.
+
+If you would like to contribute, let us know by sending an email to dev@apisix.apache.org!
## How to become an APISIX committer?
-Anyone can be a contributor to an Apache project. Being a contributor simply means that you take an interest in the project and contribute in some way, ranging from asking sensible questions (which documents the project and provides feedback to developers) through to providing new features as patches.
+Anyone can be a contributor to an Apache project. Being a contributor means that you take an interest in the project and contribute to it in some way, ranging from asking sensible questions (which documents the project and provides feedback to developers) to working on new features and patches.
-If you become a valuable contributor to the project you may well be invited to become a committer. Committer is a term used at the ASF to signify someone who is committed to a particular project. It brings with it the privilege of write access to the project repository and resources.
+If you become a valuable contributor to the project you may be invited to become a Committer. A Committer is a term used at the ASF to signify someone who is committed to a particular project. It brings with it the privilege of write access to the project repository and resources.
More details could be found [here](https://community.apache.org/contributors/).
## Promotion
-The Apache APISIX community follows the Apache Community’s process on accepting a new committer. After a contributor participates in APISIX's community actively, (P)PMC and Committers will make decisions to invite the contributor join Committers and (P)PMC.
-
-Processes are:
+The Apache APISIX community follows the Apache Community’s process on accepting a new committer. After a contributor participates in APISIX's community actively, (P)PMC and Committers will decide whether to invite the contributor to join Committers and (P)PMC.
-1. Start the discussion and vote in @private. Only current PMC member could nominate
+1. This process starts with a discussion and vote in @private. Only the current PMC members can nominate a new committer or a PMC member.
-2. If the vote passes, send an offer to become a committer with @private CC’ed
+2. If the vote passes, an offer letter is sent to the contributor to become a committer with @private CC’ed.
-3. New committer signs ICLA and apply Apache ID and email address
+3. The new committer can then sign the ICLA and apply for an Apache ID and email address.
-4. Update Team page.
+4. The [Team](/team) page is updated with the new committer.
Review comment:
```suggestion
4. Link your Apache account with your GitHub account via [GitBox](https://gitbox.apache.org/setup/).
5. The [Team](/team) page is updated with the new committer. Examples can be found in [PR#605](https://github.com/apache/apisix-website/pull/605) and [PR#881](https://github.com/apache/apisix-website/pull/881). The new committer would need to fork and clone the `apisix-website` repository locally, and create a PR to add him/herself to the Committer section on the Team page manually.
```
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org