Copilot commented on code in PR #1500:
URL: https://github.com/apache/maven-site/pull/1500#discussion_r2651039885
##########
content/apt/guides/development/guide-plugin-documentation.apt.vm:
##########
@@ -264,27 +264,27 @@ Plugin Name
* Usage
- General instructions on how to use the Plugin Name can be found on the
{{{usage.html}usage page}}. Some more
+ General instructions for using the Plugin Name can be found on the
{{{usage.html}usage page}}. Some more
specific use cases are described in the examples given below. Last but not
least, users occasionally contribute
additional examples, tips or errata to the plugin's wiki page.
- In case you still have questions regarding the plugin's usage, please have a
look at the {{{faq.html}FAQ}} and feel
- free to contact the {{{mailing-lists.html}user mailing list}}. The posts to
the mailing list are archived and could
- already contain the answer to your question as part of an older thread.
Hence, it is also worth browsing/searching
+ If you have questions regarding the plugin, consult the {{{faq.html}FAQ}}
and feel
+ free to contact the {{{mailing-lists.html}user mailing list}}. Posts to the
mailing list are archived and might
+ already contain the answer to your question. Hence, it is worth
browsing/searching
Review Comment:
The phrase "it is worth" should be "it is also worth" to maintain the
logical connection with the previous sentence. The word "also" emphasizes that
browsing the mail archive is an additional action beyond just posting to the
mailing list.
```suggestion
already contain the answer to your question. Hence, it is also worth
browsing/searching
```
##########
content/apt/guides/development/guide-plugin-documentation.apt.vm:
##########
@@ -264,27 +264,27 @@ Plugin Name
* Usage
- General instructions on how to use the Plugin Name can be found on the
{{{usage.html}usage page}}. Some more
+ General instructions for using the Plugin Name can be found on the
{{{usage.html}usage page}}. Some more
specific use cases are described in the examples given below. Last but not
least, users occasionally contribute
additional examples, tips or errata to the plugin's wiki page.
- In case you still have questions regarding the plugin's usage, please have a
look at the {{{faq.html}FAQ}} and feel
- free to contact the {{{mailing-lists.html}user mailing list}}. The posts to
the mailing list are archived and could
- already contain the answer to your question as part of an older thread.
Hence, it is also worth browsing/searching
+ If you have questions regarding the plugin, consult the {{{faq.html}FAQ}}
and feel
+ free to contact the {{{mailing-lists.html}user mailing list}}. Posts to the
mailing list are archived and might
+ already contain the answer to your question. Hence, it is worth
browsing/searching
the {{{mailing-lists.html}mail archive}}.
- If you feel like the plugin is missing a feature or has a defect, you can
fill a feature request or bug report in our
+ If you think the plugin is missing a feature or has a defect, you can file a
feature request or bug report in the
{{{issue-management.html}issue management system}}. When creating a new
issue, please provide a comprehensive description of your
- concern. Especially for fixing bugs it is crucial that the developers can
reproduce your problem. For this reason,
+ concern. Especially for fixing bugs, it is crucial that the developers can
reproduce your problem. For this reason,
entire debug logs, POMs or most preferably little demo projects attached to
the issue are very much appreciated.
- Of course, patches are welcome, too. Contributors can check out the project
from our
+ Of course, patches are welcome too. Contributors can check out the project
from our
Review Comment:
The phrase "welcome too" should be "welcome, too" (with a comma). The comma
is needed because "too" is an adverb that modifies the sentence and should be
set off by a comma for clarity.
```suggestion
Of course, patches are welcome, too. Contributors can check out the
project from our
```
--
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]
