Browse Source

github templates: fix typos and grammar

Thomas Waldmann 1 week ago
parent
commit
1b68676b8e
2 changed files with 19 additions and 20 deletions
  1. 14 15
      .github/ISSUE_TEMPLATE.md
  2. 5 5
      .github/PULL_REQUEST_TEMPLATE

+ 14 - 15
.github/ISSUE_TEMPLATE.md

@@ -1,56 +1,55 @@
 <!--
 <!--
 Thank you for reporting an issue.
 Thank you for reporting an issue.
 
 
-*IMPORTANT* -  *before* creating a new issue please look around:
- - Borgbackup documentation: http://borgbackup.readthedocs.io/en/stable/index.html
+*IMPORTANT* – before creating a new issue, please look around:
+ - BorgBackup documentation: https://borgbackup.readthedocs.io/en/stable/index.html
  - FAQ: https://borgbackup.readthedocs.io/en/stable/faq.html
  - FAQ: https://borgbackup.readthedocs.io/en/stable/faq.html
  and
  and
- - open issues in Github tracker: https://github.com/borgbackup/borg/issues
-  
+ - Open issues in the GitHub tracker: https://github.com/borgbackup/borg/issues
+
 If you cannot find a similar problem, then create a new issue.
 If you cannot find a similar problem, then create a new issue.
 
 
 Please fill in as much of the template as possible.
 Please fill in as much of the template as possible.
 -->
 -->
 
 
-## Have you checked borgbackup docs, FAQ, and open Github issues?
+## Have you checked the BorgBackup docs, FAQ, and open GitHub issues?
 
 
 No
 No
 
 
-## Is this a BUG / ISSUE report or a QUESTION?
+## Is this a bug/issue report or a question?
 
 
-Invalid
+Bug/Issue/Question
 
 
-## System information. For client/server mode post info for both machines.
+## System information. For client/server mode, post info for both machines.
 
 
 #### Your borg version (borg -V).
 #### Your borg version (borg -V).
 
 
 #### Operating system (distribution) and version.
 #### Operating system (distribution) and version.
 
 
-#### Hardware / network configuration, and filesystems used.
+#### Hardware/network configuration and filesystems used.
 
 
 #### How much data is handled by borg?
 #### How much data is handled by borg?
 
 
-#### Full borg commandline that lead to the problem (leave away excludes and passwords)
+#### Full borg command line that led to the problem (leave out excludes and passwords).
 
 
 
 
 ## Describe the problem you're observing.
 ## Describe the problem you're observing.
 
 
 #### Can you reproduce the problem? If so, describe how. If not, describe troubleshooting steps you took before opening the issue.
 #### Can you reproduce the problem? If so, describe how. If not, describe troubleshooting steps you took before opening the issue.
 
 
-#### Include any warning/errors/backtraces from the system logs
+#### Include any warnings/errors/backtraces from the system logs
 
 
 <!--
 <!--
 
 
 If this complaint relates to borg performance, please include CRUD benchmark
 If this complaint relates to borg performance, please include CRUD benchmark
 results and any steps you took to troubleshoot.
 results and any steps you took to troubleshoot.
-How to run benchmark: http://borgbackup.readthedocs.io/en/stable/usage/benchmark.html
+How to run the benchmark: https://borgbackup.readthedocs.io/en/stable/usage/benchmark.html
 
 
-*IMPORTANT* - Please mark logs and text output from terminal commands 
-or else Github will not display them correctly. 
+*IMPORTANT* – Please mark logs and terminal command output, otherwise GitHub will not display them correctly.
 An example is provided below.
 An example is provided below.
 
 
 Example:
 Example:
 ```
 ```
-this is an example how log text should be marked (wrap it with ```)
+this is an example of how log text should be marked (wrap it with ```)
 ```
 ```
 -->
 -->

+ 5 - 5
.github/PULL_REQUEST_TEMPLATE

@@ -1,8 +1,8 @@
-Thank you for contributing code to Borg, your help is appreciated!
+Thank you for contributing code to Borg; your help is appreciated!
 
 
-Please, before you submit a pull request, make sure it complies with the
-guidelines given in our documentation:
+Before you submit a pull request, please make sure it complies with the
+guidelines in our documentation:
 
 
-https://borgbackup.readthedocs.io/en/latest/development.html#contributions
+https://borgbackup.readthedocs.io/en/stable/development.html#contributions
 
 
-**Please remove all above text before submitting your pull request.**
+**Please remove the text above before submitting your pull request.**