review templates

Author: NHingerl

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,5 +1,5 @@
 name: 🐞 Bug report
-description: File a bug/issue to help us improve
+description: Report a bug or documentation issue to help us improve
 title: "[BUG]"
 labels: [bug, needs-triage]
 body:
@@ -8,45 +8,45 @@ body:
       label: Is there an existing issue for this?
       description: Please search to see if an issue already exists for the bug you encountered.
       options:
-        - label: I have searched the existing issues
+        - label: I have searched the existing issues.
           required: true
   - type: dropdown
     id: area
     attributes:
-      label: What type of issue are you facing
-      description: What type of issue are you facing?
+      label: Issue Type
+      description: Choose the type of issue you'd like to report.
       options:
-        - bug report
-        - documentation issue
+        - Bug Report
+        - Documentation Issue
     validations:
       required: true
   - type: textarea
     attributes:
-      label: Describe the bug
-      description: Provide a clear and concise description of what the bug is.
+      label: Descripton
+      description: Provide a clear and concise description of the problem. Describe where it appears, when it occurred, and what it affects.
     validations:
       required: true
   - type: textarea
     attributes:
       label: Expected Behavior
-      description: A concise description of what you expected to happen.
+      description: Describe what you expect to happen.
     validations:
       required: false
   - type: textarea
     attributes:
-      label: Add screenshots to help explain your problem
+      label: Screenshots
       description: |
-        If applicable, add screenshots to help explain your problem.
+        Optionally, add screenshots to help explain your problem.
 
-        Tip: You can attach images or files by clicking this area to highlight it and then dragging files in.
+        Tip: To attach images or files, click this area to highlight it and then drag files in.
     validations:
       required: false
   - type: textarea
     attributes:
-      label: Additional context
+      label: Additional Context
       description: |
-        Add any other context like links or references about the problem here. Anything that will give us more context about the issue you are encountering!
+        Add any other context, like links or references about the problem. Anything that gives us more context about the issue you are encountering.
 
-        Tip: You can attach images or files by clicking this area to highlight it and then dragging files in.
+        Tip: To attach images or files, click this area to highlight it and then drag files in.
     validations:
       required: false

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -5,39 +5,39 @@ labels: [enhancement, pending-decision]
 body:
   - type: dropdown
     attributes:
-      label: What area do you want to see improved?
-      description: Specify the main area that you want to see improved.
+      label: Improvement Area
+      description: Choose the area that you want to see improved.
       options:
-        - samples
-        - documentation
-        - other
+        - Samples
+        - Documentation
+        - Other
     validations:
       required: true
   - type: textarea
     id: area
     attributes:
-      label: Is your feature request related to a problem? Please describe.
-      description: Provide a clear and concise description of what the problem is e.g., I am always frustrated when [...]
+      label: Is your feature request related to a problem?
+      description: Provide a clear and concise description of what the problem is. For example, I am always frustrated when ...
     validations:
       required: true
   - type: textarea
     attributes:
-      label: Describe the solution you would like
-      description: A clear and concise description of what you want to happen.
+      label: Desired Solution
+      description: A clear and concise description of the solution you would like to see.
     validations:
       required: true
   - type: textarea
     attributes:
-      label: Describe alternatives you have considered
-      description: A clear and concise description of any alternative solutions or features you have considered.
+      label: Alternative Solutions
+      description: Describe any alternative solutions or features you have considered.
     validations:
       required: false
   - type: textarea
     attributes:
-      label: Additional context
+      label: Additional Context
       description: |
         Add any other context like links or references about the problem here. Anything that will give us more context about the issue you are encountering!
 
-        Tip: You can attach images or files by clicking this area to highlight it and then dragging files in.
+        Tip: To attach images or files, click this area to highlight it and then drag files in.
     validations:
       required: false

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,16 +1,16 @@
 ## Purpose
-<!-- Describe the intention of the changes being proposed. What problem does it solve or functionality does it add? -->
+<!-- Describe the purpose of the change you are proposing. What problem does it solve or functionality does it add? -->
 - ...
 
 ## Pull Request Type
 
-What kind of change does this Pull Request introduce?
-<!-- Please check the one that applies to this PR using "X". -->
+What kind of change does this pull request introduce?
+<!-- To check the type that applies to this PR, add an "X". -->
 ```
 [ ] Bugfix
 [ ] Feature
-[ ] Refactoring (no functional changes, no api changes)
-[ ] Documentation content changes
+[ ] Refactoring (no functional changes, no API changes)
+[ ] Documentation improvement
 [ ] Other... Please describe:
 ```
 

.github/workflows/feature-request-response.yml

@@ -11,7 +11,7 @@ jobs:
     if: ${{ contains(github.event.issue.labels.*.name, 'enhancement') }}
     runs-on: ubuntu-latest
     steps:
-      - name: 'Add community note to new Issues'
+      - name: 'Add community note to new issues'
         uses: peter-evans/create-or-update-comment@71345be0265236311c031f5c7866368bd1eff043 # v4.0.0
         with:
           issue-number: ${{ github.event.issue.number }}
@@ -23,7 +23,7 @@ jobs:
             ### Voting for Prioritization
 
             * Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original post to help the community and maintainers prioritize this request.
-            * Please **do not** leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.
+            * Please **do not** leave "+1" or other comments that do not add relevant new information or questions. They generate extra noise for issue followers and do not help prioritize the request.
 
             ### Volunteering to Work on This Issue
 

.github/workflows/links-watcher-cron.yml

@@ -38,7 +38,7 @@ jobs:
         if: failure()
         with:
           title: Link Checker Report
-          # If issue number is empty a new issue gets created
+          # If issue number is empty, a new issue is created
           issue-number: ${{ steps.find_issue.outputs.issue-number }}
           content-filepath: ./lychee/out.md
           labels: broken link, automated issue

.github/workflows/stale-handling.yml

@@ -13,8 +13,8 @@ jobs:
     steps:
       - uses: actions/stale@v9
         with:
-          stale-issue-message: 'This issue is stale because it has been open 15 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
-          stale-pr-message: 'This pull request is stale because it has been open 15 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
+          stale-issue-message: 'This issue is stale because it has been open 15 days with no activity. Remove stale label or comment, or this will be closed in 5 days.'
+          stale-pr-message: 'This pull request is stale because it has been open 15 days with no activity. Remove stale label or comment, or this will be closed in 5 days.'
           close-issue-message: 'This issue was closed because it has been stalled for 5 days with no activity.'
           close-pr-message: 'This PR was closed because it has been stalled for 5 days with no activity.'
           days-before-stale: 15