Docs: Add a pull_request_template.

Completely resolves STAR-1.

This also properly adds ignore files for `markdownlint` as that didn't
properly work beforehand.

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,12 @@
+<!--
+     For Work In Progress Pull Requests, please use the Draft PR feature,
+     https://github.blog/2019-02-14-introducing-draft-pull-requests/.
+-->
+
+## Checklist
+
+ - [ ] I have read [the Contribution Guidelines](/CONTRIBUTING.md).
+ - [ ] [Tests](/vitest.config.ts) have been added if applicable.
+ - [ ] The changes have been well documented and explained in this PR.
+ - [ ] If relevant I have attached screenshot(s) of the change.
+ - [ ] [Documentation](/docs/) has been updated.

.markdownlint-cli2.jsonc

@@ -0,0 +1,25 @@
+{
+    "$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/main/schema/markdownlint-cli2-config-schema.json",
+    "config": {
+        "default": true,
+        "spaces": true,
+        "no-hard-tabs": true,
+        "no-trailing-punctuation": {
+            "punctuation": ".,;:!。，；：！"
+        },
+        "list-marker-space": {
+            "ol_single": 1,
+            "ol_multi": 1,
+            "ul_single": 1,
+            "ul_multi": 1
+        },
+        "ul-indent": {
+            "indent": 1,
+            "start_indent": 1,
+            "start_indented": true
+        },
+        "line-length": false,
+        "first-line-heading": false
+    },
+    "ignores": ["**/.changeset/**.md", "**/CHANGELOG.md"]
+}

.vscode/settings.json

@@ -40,6 +40,5 @@
     "markdown.extension.toc.omittedFromToc": {
         "CONTRIBUTING.md": ["## Table of Contents"]
     },
-    "markdown.extension.toc.slugifyMode": "github",
-    "markdownlint.ignore": ["**/.changeset/**.md"]
+    "markdown.extension.toc.slugifyMode": "github"
 }

plopfile.js

@@ -59,7 +59,7 @@ module.exports = function main(plop) {
 
                     validate: (value) => {
                         if (!value) {
-                            return `${gen} name is required`;
+                            return `${gen} description is required`;
                         }
 
                         return true;
@@ -68,7 +68,7 @@ module.exports = function main(plop) {
                 {
                     type: 'list',
                     name: 'outDir',
-                    message: `where should this ${gen} live?`,
+                    message: `Where should this ${gen} live?`,
                     default: defaultOutDirs[gen],
                     choices: workspaces,