yzeng25 commented on a change in pull request #888: URL: https://github.com/apache/apisix-website/pull/888#discussion_r810826621
########## File path: website/docs/general/contributor-guide.md ########## @@ -9,45 +9,41 @@ keywords: description: This article is a set of guidelines for Apache APISIX contributors, including things that a contributor can do and how to do it well. --- -Please fee free to report bugs, submit suggestions, or submit PRs according to this guide. +Please follow this guide to [report bugs](#submit-an-issue), [submit suggestions](#submit-an-issue), or [submit PRs](#submit-pr). -## Submit an issue +## Submitting an Issue -1. Before submitting your issues, please go through a comprehensive search to make sure the problem cannot be solved just by searching. +Before submitting an issue, try solving the problem through a comprehensive search. -2. Check the Issue List to make sure the problem is not repeated. +[Open issues](https://github.com/apache/apisix/issues) and the [discussions forum](https://github.com/apache/apisix/discussions) are good places to search for solutions before opening an issue. -3. Create a new issue and choose the type of issue. +1. Check the [open issues](https://github.com/apache/apisix/issues) to avoid duplication. -4. Define the issue with a clear and descriptive title. +2. Create a [new issue](https://github.com/apache/apisix/issues/new/choose) and choose the type of issue. -5. Fill in necessary information according to the template. +3. Define the issue with a clear and descriptive title. -6. Choose a label after issue created. +4. Fill in necessary information according to the template. -7. Please pay attention to your issue, you may need provide more information during discussion. +5. Choose proper label(s) after opening the issue. Review comment: I asked other contributors to mock the process of opening an issue. It turns out that contributors are not able to change/select the labels by their own. I would suggest to delete this step for now. We would definitely need to figure out the grainarities, accesses, and responsibilities here. ```suggestion ``` ########## File path: website/docs/general/contributor-guide.md ########## @@ -9,45 +9,41 @@ keywords: description: This article is a set of guidelines for Apache APISIX contributors, including things that a contributor can do and how to do it well. --- -Please fee free to report bugs, submit suggestions, or submit PRs according to this guide. +Please follow this guide to [report bugs](#submit-an-issue), [submit suggestions](#submit-an-issue), or [submit PRs](#submit-pr). -## Submit an issue +## Submitting an Issue -1. Before submitting your issues, please go through a comprehensive search to make sure the problem cannot be solved just by searching. +Before submitting an issue, try solving the problem through a comprehensive search. -2. Check the Issue List to make sure the problem is not repeated. +[Open issues](https://github.com/apache/apisix/issues) and the [discussions forum](https://github.com/apache/apisix/discussions) are good places to search for solutions before opening an issue. -3. Create a new issue and choose the type of issue. +1. Check the [open issues](https://github.com/apache/apisix/issues) to avoid duplication. -4. Define the issue with a clear and descriptive title. +2. Create a [new issue](https://github.com/apache/apisix/issues/new/choose) and choose the type of issue. -5. Fill in necessary information according to the template. +3. Define the issue with a clear and descriptive title. -6. Choose a label after issue created. +4. Fill in necessary information according to the template. -7. Please pay attention to your issue, you may need provide more information during discussion. +5. Choose proper label(s) after opening the issue. -## Developer Flow +6. Engage in the discussions in the issue and provide more information if necessary. -### Fork repo +## Choosing an Issue to Work On -Fork the Apache APISIX repo to your own repo to work, then setting proper upstream. +You can also contribute by fixing one of the [open issues](https://github.com/apache/apisix/issues). -```sh -git remote add upstream https://github.com/apache/apisix.git -``` - -### Choose an issue +1. Once you have chosen an issue to work on or [opened a new issue](#submitting-an-issue), indicate that you would like to work on it by adding a comment. -1. Please choose your target issue. 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. +2. Please check to see if the issue is already being worked on and indicate when you will be able to complete it. -2. After choosing the relevant issue, please reply with a deadline to indicate that you are working on it. +3. Connect with a [mentor](/team) for providing feedback on your issue and reviewing your PR. Review comment: Committer or PMC or PMC would be more accurate IMHO. ```suggestion 3. Connect with a [Committer or PMC](/team) for providing feedback on your issue and reviewing your PR. ``` ########## File path: website/docs/general/contributor-guide.md ########## @@ -9,45 +9,41 @@ keywords: description: This article is a set of guidelines for Apache APISIX contributors, including things that a contributor can do and how to do it well. --- -Please fee free to report bugs, submit suggestions, or submit PRs according to this guide. +Please follow this guide to [report bugs](#submit-an-issue), [submit suggestions](#submit-an-issue), or [submit PRs](#submit-pr). -## Submit an issue +## Submitting an Issue -1. Before submitting your issues, please go through a comprehensive search to make sure the problem cannot be solved just by searching. +Before submitting an issue, try solving the problem through a comprehensive search. -2. Check the Issue List to make sure the problem is not repeated. +[Open issues](https://github.com/apache/apisix/issues) and the [discussions forum](https://github.com/apache/apisix/discussions) are good places to search for solutions before opening an issue. -3. Create a new issue and choose the type of issue. +1. Check the [open issues](https://github.com/apache/apisix/issues) to avoid duplication. -4. Define the issue with a clear and descriptive title. +2. Create a [new issue](https://github.com/apache/apisix/issues/new/choose) and choose the type of issue. -5. Fill in necessary information according to the template. +3. Define the issue with a clear and descriptive title. -6. Choose a label after issue created. +4. Fill in necessary information according to the template. -7. Please pay attention to your issue, you may need provide more information during discussion. +5. Choose proper label(s) after opening the issue. -## Developer Flow +6. Engage in the discussions in the issue and provide more information if necessary. -### Fork repo +## Choosing an Issue to Work On -Fork the Apache APISIX repo to your own repo to work, then setting proper upstream. +You can also contribute by fixing one of the [open issues](https://github.com/apache/apisix/issues). -```sh -git remote add upstream https://github.com/apache/apisix.git -``` - -### Choose an issue +1. Once you have chosen an issue to work on or [opened a new issue](#submitting-an-issue), indicate that you would like to work on it by adding a comment. Review comment: ```suggestion 1. Once you have chosen an issue to work on or [opened a new issue](#submitting-an-issue), please comment under the issue and ask a [Committer or PMC](/team) to assign it to you. Or you can claim the issue when you create it. ``` ########## File path: website/docs/general/contributor-guide.md ########## @@ -9,45 +9,41 @@ keywords: description: This article is a set of guidelines for Apache APISIX contributors, including things that a contributor can do and how to do it well. --- -Please fee free to report bugs, submit suggestions, or submit PRs according to this guide. +Please follow this guide to [report bugs](#submit-an-issue), [submit suggestions](#submit-an-issue), or [submit PRs](#submit-pr). Review comment: The in-page link works when the link fits the section title. Would be nice to update both of them. ```suggestion Please follow this guide to [report bugs](#submitting-an-issue), [submit suggestions](#submitting-an-issue), or [submit PRs](#open-a-pull-request). ``` -- 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]
