docs: clarification re scope of package (more)

holvonix-open · Aug 14, 2019 · 6e8935e · 6e8935e
1 parent 649ea52
commit 6e8935e
Show file tree

Hide file tree

Showing 5 changed files with 69 additions and 89 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -3,31 +3,33 @@ name: Bug report
 about: Create a report to help us improve
 ---
 
-**NOTE:
-By submitting this issue, you hereby license all content you contribute to this
-repository (including but not limited to this issue and all bugs, commits,
-pull requests, feature requests, and suggestions) under the repository's
+**NOTE: By submitting this issue, you hereby license all content you contribute
+to this repository (including but not limited to this issue and all bugs,
+commits, pull requests, feature requests, and suggestions) under the
+repository's
 [LICENSE](https://github.com/holvonix-open/release-config-js/blob/master/LICENSE).
 You also represent and warrant that you have all necessary rights to license the
-content as specified in the preceding sentence and that doing so will not infringe
-upon any right of any third party nor violate any applicable law or regulation.**
+content as specified in the preceding sentence and that doing so will not
+infringe upon any right of any third party nor violate any applicable law or
+regulation.**
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+**Note:** while we're pleased to make this preset public, it will remain
+tailored to our particular needs. If your team needs its own config, please fork
+under the terms of the license.
 
-**To Reproduce**
-Steps to reproduce the behavior:
+**Describe the bug** A clear and concise description of what the bug is.
+
+**To Reproduce** Steps to reproduce the behavior:
 
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+**Expected behavior** A clear and concise description of what you expected to
+happen.
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+**Screenshots** If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
 
@@ -42,5 +44,4 @@ If applicable, add screenshots to help explain your problem.
 - Browser [e.g. stock browser, safari]
 - Version [e.g. 22]
 
-**Additional context**
-Add any other context about the problem here.
+**Additional context** Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -3,23 +3,28 @@ name: Feature request
 about: Suggest an idea for this project
 ---
 
-**NOTE:
-By submitting this issue, you hereby license all content you contribute to this
-repository (including but not limited to this issue and all bugs, commits,
-pull requests, feature requests, and suggestions) under the repository's
+**NOTE: By submitting this issue, you hereby license all content you contribute
+to this repository (including but not limited to this issue and all bugs,
+commits, pull requests, feature requests, and suggestions) under the
+repository's
 [LICENSE](https://github.com/holvonix-open/release-config-js/blob/master/LICENSE).
 You also represent and warrant that you have all necessary rights to license the
-content as specified in the preceding sentence and that doing so will not infringe
-upon any right of any third party nor violate any applicable law or regulation.**
+content as specified in the preceding sentence and that doing so will not
+infringe upon any right of any third party nor violate any applicable law or
+regulation.**
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+**Note:** while we're pleased to make this preset public, it will remain
+tailored to our particular needs. If your team needs its own config, please fork
+under the terms of the license.
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+**Is your feature request related to a problem? Please describe.** A clear and
+concise description of what the problem is. Ex. I'm always frustrated when [...]
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+**Describe the solution you'd like** A clear and concise description of what you
+want to happen.
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+**Describe alternatives you've considered** A clear and concise description of
+any alternative solutions or features you've considered.
+
+**Additional context** Add any other context or screenshots about the feature
+request here.
diff --git a/.github/issue_template.md b/.github/issue_template.md
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,17 +1,23 @@
-**NOTE:
-By submitting this pull request, you hereby license all content you contribute to this
-repository (including but not limited to this pull request and all bugs, commits,
-pull requests, feature requests, and suggestions) under the repository's
+**NOTE: By submitting this pull request, you hereby license all content you
+contribute to this repository (including but not limited to this pull request
+and all bugs, commits, pull requests, feature requests, and suggestions) under
+the repository's
 [LICENSE](https://github.com/holvonix-open/release-config-js/blob/master/LICENSE).
 You also represent and warrant that you have all necessary rights to license the
-content as specified in the preceding sentence and that doing so will not infringe
-upon any right of any third party nor violate any applicable law or regulation.**
+content as specified in the preceding sentence and that doing so will not
+infringe upon any right of any third party nor violate any applicable law or
+regulation.**
 
-Do not contribute or copy-paste third-party content, code or data using a pull request. Instead provide
-URLs to the authoritative source and to license information and we'll see if we want to include it.
+Do not contribute or copy-paste third-party content, code or data using a pull
+request. Instead provide URLs to the authoritative source and to license
+information and we'll see if we want to include it.
 
 ---
 
+**Note:** while we're pleased to make this preset public, it will remain
+tailored to our particular needs. If your team needs its own config, please fork
+under the terms of the license.
+
 [Include a one-sentence summary of the change.]
 
 [Include a longer description of the change and anything complicated.]
@@ -20,10 +26,19 @@ URLs to the authoritative source and to license information and we'll see if we
 
 [Please always squash and rebase your commits to ONE commit.]
 
-[Please include the following at the bottom of the commit message (not in this pull request):
+[Please include the following at the bottom of the commit message (not in this
+pull request):
 
-"I, (Your Name), hereby license all contents of this commit under the license described in the LICENSE file in the root of this repository, and I represent and warrant that (1) I have all necessary rights to license the contents as such and (2) doing so does not infringe upon any right of any third party nor violate any applicable law or regulation."
+"I, (Your Name), hereby license all contents of this commit under the license
+described in the LICENSE file in the root of this repository, and I represent
+and warrant that (1) I have all necessary rights to license the contents as such
+and (2) doing so does not infringe upon any right of any third party nor violate
+any applicable law or regulation."
 
-NOTE: You should consult an attorney on whether or not this agreement is appropriate for you (including but not limited to whether your employer or others may have rights to your content). We cannot provide any legal advice to you, and if you cannot license your content as such, we can't accept any contribution from you.]
+NOTE: You should consult an attorney on whether or not this agreement is
+appropriate for you (including but not limited to whether your employer or
+others may have rights to your content). We cannot provide any legal advice to
+you, and if you cannot license your content as such, we can't accept any
+contribution from you.]
 
 ---
diff --git a/package.json b/package.json
@@ -28,10 +28,15 @@
   "license": "ISC",
   "private": false,
   "scripts": {
-    "test": "prettier --check '**/*.yml' '**/*.yaml' 'README.md' '**/*.js' '**/*.json'",
-    "fix": "prettier --write '**/*.yml' '**/*.yaml' 'README.md' '**/*.js' '**/*.json'",
+    "pretty.check": "prettier --check $npm_package_prettierGlob_include",
+    "pretty.fix": "prettier --write $npm_package_prettierGlob_include",
+    "test": "yarn run pretty.check",
+    "fix": "yarn run pretty.fix",
     "semantic-release": "semantic-release"
   },
+  "prettierGlob": {
+    "include": "**/*.yml **/*.yaml **/*.md **/*.json *.js !CHANGELOG.md"
+  },
   "release": {
     "extends": "./index.js"
   },