Merge pull request #6 from rootwork/wording-suggestions

Wording suggestions
dec0dOS · Nov 3, 2021 · 2383a11 · 2383a11
2 parents 408836f + 151556a
commit 2383a11
Show file tree

Hide file tree

Showing 10 changed files with 88 additions and 76 deletions.
diff --git a/README.md b/README.md
@@ -52,11 +52,11 @@
 <tr>
 <td>
 
-Open Source Software is not about the code in the first place but the communications and community. People love good documentation and obvious workflows. If your software solves some problem, but nobody can figure out how to use it or, for example, how to create an effective bug report, there's something very bad going on. Did you hear about Readme Driven Development? Check out the awesome [artice written by GitHub co-founder Tom Preston-Werner](https://tom.preston-werner.com/2010/08/23/readme-driven-development.html).
+Open Source Software is not about the code in the first place but the communications and community. People love good documentation and obvious workflows. If your software solves some problem, but nobody can figure out how to use it or, for example, how to create an effective bug report, there's something very bad going on. Did you hear about Readme Driven Development? Check out the awesome [article written by GitHub co-founder Tom Preston-Werner](https://tom.preston-werner.com/2010/08/23/readme-driven-development.html).
 
-There are many great README or issues templates available on GitHub, however, you have to find them yourself and combine different templates yourself. In addition, if you want extensive docs like CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md or even advanced GitHub features like pull request template, additional labels, code scanning, and automatic issues/PRs closing and locking you have to do much work. Your time should be focused on creating something **amazing**. You shouldn't be doing the same tasks over and over like creating your GitHub project template from scratch. Follow the **don’t repeat yourself** principle. So just use the template **and go create something amazing**!
+There are many great README or issues templates available on GitHub, however, you have to find them yourself and combine different templates yourself. In addition, if you want extensive docs like CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md or even advanced GitHub features like a pull request template, additional labels, code scanning, and automatic issue/PR closing and locking you have to do much more work. Your time should be focused on creating something **amazing**. You shouldn't be doing the same tasks over and over like creating your GitHub project template from scratch. Follow the **don’t repeat yourself** principle. Use a template **and go create something amazing**!
 
-The key features of **Amazing GitHub Template**:
+Key features of **Amazing GitHub Template**:
 
 - Configurable README.md template
 - Configurable LICENSE template
@@ -78,7 +78,7 @@ The key features of **Amazing GitHub Template**:
 
 This project is the result of huge research. I'm a long-time GitHub user so I've seen more than [7.3k](https://github.com/dec0dOS?tab=stars) READMEs so far. I've started writing docs for my open source projects (that are currently in their early stages so they exist in the private space for now). After I've analyzed many popular GitHub READMEs and other GitHub-related docs and features I've tried to create a general-propose template that may be useful for any project.
 
-Of course, no template will serve all the projects since your needs may be different. So the [Cookiecutter](https://github.com/cookiecutter/cookiecutter) comes to the rescue. It allows [Jinja template language](https://jinja.palletsprojects.com) to be used for complex cases. Just enter up the project preferences you want in the Cookiecutter interactive menu and that's it. There is a manual setup that could be useful for your existing projects (or if you don't want to use Cookiecutter for some reason). **This README.md file is not a template itself**, you should [download the precompiled template](https://github.com/dec0dOS/amazing-github-template/releases/download/latest/template.zip) and replace the predefined values, then remove unused sections.
+Of course, no template will serve all the projects since your needs may be different. So [Cookiecutter](https://github.com/cookiecutter/cookiecutter) comes to the rescue. It allows [Jinja template language](https://jinja.palletsprojects.com) to be used for complex cases. Just enter up the project preferences you want in the Cookiecutter interactive menu and that's it. There is a manual setup that could be useful for your existing projects (or if you don't want to use Cookiecutter for some reason). **This README.md file is not a template itself**, you should [download the precompiled template](https://github.com/dec0dOS/amazing-github-template/releases/download/latest/template.zip) and replace the predefined values, then remove unused sections.
 
 </details>
 
@@ -117,7 +117,7 @@ After installing Cookiecutter, all you need to do is to run the following comman
 cookiecutter gh:dec0dOS/amazing-github-template
 ```
 
-You will get the interactive prompt where you'll need to specify relevant options for your project (or the default value will be used).
+You will get an interactive prompt where you'll specify relevant options for your project (or the default value will be used).
 
 ![Preview](docs/images/preview.svg)
 
@@ -131,7 +131,7 @@ Please follow these steps for manual setup:
 
     `or`
 
-    Move the necessary files from precompiled template folder to your existing project directory. Don't forget .github directory that may be hidden by default in your operating system
+    Move the necessary files from precompiled template folder to your existing project directory. Don't forget the `.github` directory that may be hidden by default in your operating system
 
 #### Variables reference
 
@@ -149,7 +149,7 @@ Default values are provided as an example to help you figure out what should be
 | OPEN_SOURCE_LICENSE        | MIT license        | Full OSS license name                                                       |
 | modern_header              | y                  | Use HTML to prettify your header                                            |
 | table_in_about             | n                  | Use table to wrap around About section                                      |
-| include_logo               | y                  | Include Logo section. Could only be used when `modern_header == y`          |
+| include_logo               | y                  | Include Logo section. Only valid when `modern_header == y`          |
 | include_badges             | y                  | Include section for badges                                                  |
 | include_toc                | y                  | Include Table of Contents                                                   |
 | include_screenshots        | y                  | Include Screenshots section                                                 |
@@ -186,7 +186,7 @@ Please try to create bug reports that are:
 
 Please adhere to this project's [code of conduct](docs/CODE_OF_CONDUCT.md).
 
-You could use [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) to check for common markdown style inconsistency.
+You can use [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) to check for common markdown style inconsistency.
 
 ## Support
 

diff --git a/{{cookiecutter.repo_slug}}/.github/ISSUE_TEMPLATE/01_BUG_REPORT.md b/{{cookiecutter.repo_slug}}/.github/ISSUE_TEMPLATE/01_BUG_REPORT.md
@@ -18,11 +18,11 @@ assignees: ""
 
 **Expected behavior:**
 
-<!-- Describe what the behavior would be without the bug. -->
+<!-- Describe what you expect the behavior to be without the bug. -->
 
 **Steps to reproduce:**
 
-<!--  Please explain the steps required to duplicate the issue, especially if you are able to provide a sample application. -->
+<!-- Explain the steps required to duplicate the issue, especially if you are able to provide a sample application. -->
 
 **Related code:**
 

diff --git a/{{cookiecutter.repo_slug}}/.github/PULL_REQUEST_TEMPLATE.md b/{{cookiecutter.repo_slug}}/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,16 +1,16 @@
 <!--- Please provide a general summary of your changes in the title above -->
 
-## Pull request type
+## Pull Request type
 
-<!-- Please try to limit your pull request to one type, submit multiple pull requests if needed. -->
+<!-- Please try to limit your pull request to one type; submit multiple pull requests if needed. -->
 
 Please check the type of change your PR introduces:
 
 - [ ] Bugfix
 - [ ] Feature
 - [ ] Code style update (formatting, renaming)
-- [ ] Refactoring (no functional changes, no api changes)
-- [ ] Build related changes
+- [ ] Refactoring (no functional changes, no API changes)
+- [ ] Build-related changes
 - [ ] Documentation content changes
 - [ ] Other (please describe):
 
@@ -33,8 +33,8 @@ Issue Number: N/A
 - [ ] Yes
 - [ ] No
 
-<!-- If this introduces a breaking change, please describe the impact and migration path for existing applications below. -->
+<!-- If this does introduce a breaking change, please describe the impact and migration path for existing applications below. -->
 
 ## Other information
 
-<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->
+<!-- Any other information that is important to this PR, such as screenshots of how the component looks before and after the change. -->
diff --git a/{{cookiecutter.repo_slug}}/.github/labels.yml b/{{cookiecutter.repo_slug}}/.github/labels.yml
@@ -1,7 +1,7 @@
 ---
 - name: "breaking-change"
   color: ee0701
-  description: "A breaking change for existing users."
+  description: "A change that changes the API or breaks backward compatibility for users."
 - name: "bugfix"
   color: ee0701
   description: "Inconsistencies or issues which will cause a problem for users or implementors."
@@ -13,10 +13,10 @@
   description: "Enhancement of the code, not introducing new features."
 - name: "refactor"
   color: 1d76db
-  description: "Improvement of existing code, not introducing new features."
+  description: "Updating the code with simpler, easier to understand or more efficient syntax or methods, but not introducing new features."
 - name: "performance"
   color: 1d76db
-  description: "Improving performance, not introducing new features."
+  description: "Improving performance of the project, not introducing new features."
 - name: "new-feature"
   color: 0e8a16
   description: "New features or options."
@@ -25,41 +25,41 @@
   description: "Generic maintenance tasks."
 - name: "ci"
   color: 1d76db
-  description: "Work that improves the continue integration."
+  description: "Work that improves the continuous integration."
 - name: "dependencies"
   color: 1d76db
-  description: "Upgrade or downgrade of project dependencies."
+  description: "Change in project dependencies."
 
 - name: "in-progress"
   color: fbca04
-  description: "Issue is currently being resolved by a developer."
+  description: "Issue is currently being worked on by a developer."
 - name: "stale"
   color: fef2c0
-  description: "There has not been activity on this issue or PR for quite some time."
+  description: "No activity for quite some time."
 - name: "no-stale"
   color: fef2c0
-  description: "This issue or PR is exempted from the stable bot."
+  description: "This is exempt from the stale bot."
 
 - name: "security"
   color: ee0701
-  description: "Marks a security issue that needs to be resolved ASAP."
+  description: "Addressing a vulnerability or security risk in this project."
 - name: "incomplete"
   color: fef2c0
-  description: "Marks a PR or issue that is missing information."
+  description: "Missing information."
 - name: "invalid"
   color: fef2c0
-  description: "Marks a PR or issue that is missing information."
+  description: "This is off-topic, spam, or otherwise doesn't apply to this project."
 
 - name: "beginner-friendly"
   color: 0e8a16
-  description: "Good first issue for people wanting to contribute to the project."
+  description: "Good first issue for people wanting to contribute to this project."
 - name: "help-wanted"
   color: 0e8a16
-  description: "We need some extra helping hands or expertise in order to resolve this."
+  description: "We need some extra helping hands or expertise in order to resolve this!"
 
 - name: "priority-critical"
   color: ee0701
-  description: "This should be dealt with ASAP. Not fixing this issue would be a serious error."
+  description: "Must be addressed as soon as possible."
 - name: "priority-high"
   color: b60205
   description: "After critical issues are fixed, these should be dealt with before any further issues."
@@ -72,7 +72,7 @@
 
 - name: "major"
   color: b60205
-  description: "This PR causes a major version bump in the version number."
+  description: "This PR causes a major bump in the version number."
 - name: "minor"
   color: 0e8a16
-  description: "This PR causes a minor version bump in the version number."
+  description: "This PR causes a minor bump in the version number."
diff --git a/{{cookiecutter.repo_slug}}/.github/workflows/lock.yml b/{{cookiecutter.repo_slug}}/.github/workflows/lock.yml
@@ -16,6 +16,18 @@ jobs:
           github-token: ${{ github.token }}
           issue-lock-inactive-days: "30"
           issue-lock-reason: ""
+          issue-comment: >
+            Issue closed and locked due to lack of activity.
+
+            If you encounter this same issue, please open a new issue and refer
+            to this closed one.
           pr-lock-inactive-days: "1"
           pr-lock-reason: ""
+          pr-comment: >
+            Pull Request closed and locked due to lack of activity.
+
+            If you'd like to build on this closed PR, you can clone it using
+            this method: https://stackoverflow.com/a/14969986
+
+            Then open a new PR, referencing this closed PR in your message.
 {% endraw %}
diff --git a/{{cookiecutter.repo_slug}}/.github/workflows/stale.yml b/{{cookiecutter.repo_slug}}/.github/workflows/stale.yml
@@ -21,20 +21,25 @@ jobs:
           stale-issue-label: "stale"
           exempt-issue-labels: "no-stale,help-wanted"
           stale-issue-message: >
-            There hasn't been any activity on this issue recently, so we
-            clean up some of the older and inactive issues.
+            There hasn't been any activity on this issue recently, and in order
+            to prioritize active issues, it will be marked as stale.
 
             Please make sure to update to the latest version and
             check if that solves the issue. Let us know if that works for you
-            by leaving a comment 👍.
+            by leaving a 👍
 
-            This issue has now been marked as stale and will be closed if no
-            further activity occurs. Thanks!
+            Because this issue is marked as stale, it will be closed and locked
+            in 7 days if no further activity occurs.
+
+            Thank you for your contributions!
           stale-pr-label: "stale"
           exempt-pr-labels: "no-stale"
           stale-pr-message: >
-            There hasn't been any activity on this pull request recently. This
-            pull request has been automatically marked as stale because of that
-            and will be closed if no further activity occurs within 7 days.
-            Thank you for your contributions.
+            There hasn't been any activity on this pull request recently, and in
+            order to prioritize active work, it has been marked as stale.
+
+            This PR will be closed and locked in 7 days if no further activity
+            occurs.
+
+            Thank you for your contributions!
 {% endraw %}