feat(@videndum/release-mastermind): documentation overhaul, json schema, staleness, schedules and more #AM-1

.eslintrc.js

@@ -0,0 +1,19 @@
+/** @format */
+
+module.exports = {
+	root: true,
+	parser: "@typescript-eslint/parser",
+	plugins: ["@typescript-eslint", "import", "eslint-comments"],
+	extends: [
+		"eslint:recommended",
+		"plugin:@typescript-eslint/recommended",
+		"plugin:import/recommended",
+		"plugin:import/typescript",
+		"plugin:eslint-comments/recommended",
+		"prettier",
+		"eslint-plugin-tsdoc"
+	],
+	rules: {
+		"tsdoc/syntax": "warn"
+	}
+}

.gitattributes

@@ -0,0 +1 @@
+*.json linguist-language=JSON-with-Comments

.github/CODEOWNERS

@@ -1,5 +1,5 @@
-*       @Videndum
-*.yml    @Videndum/automation
-docs/*/**  @Videndum/community
+* @Videndum
+*.yml @Videndum/automation
+docs/*/** @Videndum/community
 docs\getting-started\contributing\CODE_OF_CONDUCT.md @Videndum/admins
 docs\getting-started\contributing\AGREEMENT.md @Videndum/security

.github/ISSUE_TEMPLATE/FIRST_TIMERS_ISSUE_TEMPLATE.md

@@ -1,3 +1,5 @@
+<!-- @format -->
+
 <!-- this issue template is used by https://github.com/apps/first-timers -->
 
 ### 🆕🐥☝ First Timers Only

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,9 +1,11 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: 'bug([context]): '
+title: "bug([context]): "
 ---
 
+<!-- @format -->
+
 <!-- Please use [context] in title to describe the package related to this issue.
 Valid options are; Release, Label, Variable, Installer
 context example: bug(installer): {your title here}
@@ -39,6 +41,7 @@ insert debug output here
 ## Device Information
 
 <!-- Please delete all information not relivent-->
+
 - Version: [e.g. 22]
 - Platform: [e.g. macOS, Google Cloud, ubuntu 18.04]
 - Browser: [e.g. stock browser, safari]

.github/ISSUE_TEMPLATE/config.yml

@@ -1,3 +1,5 @@
+# @format
+
 blank_issues_enabled: false
 contact_links:
   - name: Discussion

.github/ISSUE_TEMPLATE/doc_review.md

@@ -1,9 +1,11 @@
 ---
 name: Documentation review
 about: A review to highlight issues in documentation
-title: 'docs([context]): '
+title: "docs([context]): "
 ---
 
+<!-- @format -->
+
 <!-- Please use [context] in title to describe the package related to this issue.
 Valid options are; Release, Label, Variable, Installer
 context example: bug(installer): {your title here}
@@ -12,6 +14,7 @@ context example: bug(installer): {your title here}
 ## Problem to solve
 
 <!-- Please delete all information not relivent-->
+
 - What product or feature(s) affected?
 - What docs or doc section involved? Include links or paths.
 - Is there a problem with a specific document, or a feature/process that's not addressed sufficiently in docs?
@@ -27,6 +30,7 @@ context example: bug(installer): {your title here}
 ## References
 
 <!-- Please delete all information not relivent-->
+
 Related Pull Request(s):
 Related issue(s):
 

.github/ISSUE_TEMPLATE/fix.md

@@ -1,9 +1,11 @@
 ---
 name: Code fix
 about: Let us know about a solution to an existing bug
-title: 'fix([context]): '
+title: "fix([context]): "
 ---
 
+<!-- @format -->
+
 <!-- Please use [context] in title to describe the package related to this issue.
 Valid options are; Release, Label, Variable, Installer
 context example: bug(installer): {your title here}
@@ -12,6 +14,7 @@ context example: bug(installer): {your title here}
 ## Describe the fix
 
 Addresses bug: #{number}
+
 <!-- A clear and concise description of what the fix is. -->
 
 ### Expected behaviour
@@ -25,6 +28,7 @@ Addresses bug: #{number}
 ## Device Information
 
 <!-- Please delete all information not relivent-->
+
 - Version: [e.g. 22]
 - Platform: [e.g. macOS, Google Cloud, ubuntu 18.04]
 - Browser: [e.g. stock browser, safari]
@@ -50,4 +54,4 @@ We would appreciate it if you could maintain this section cleanly and clearly. I
 - [ ] Have fixed on a development build
 - [ ] Have included logs or screenshots
 - [ ] Have linked any related issues
-- [ ] Fix confirmed by <!--@yourusername & @friendsusername-->
+- [ ] Fix confirmed by <!--@yourusername & @friendsusername-->

.github/ISSUE_TEMPLATE/maintenance.md

@@ -1,9 +1,11 @@
 ---
 name: Code maintenance
 about: Requesting Styling, Refactoring, Optimisation, Revert, Deprecated or Removal of an existing feature
-title: 'maintenance([context]): '
+title: "maintenance([context]): "
 ---
 
+<!-- @format -->
+
 <!-- Please use [context] in title to describe the package related to this issue.
 Valid options are; Release, Label, Variable, Installer
 context example: bug(installer): {your title here}

.github/ISSUE_TEMPLATE/outdated/discussion.md

@@ -1,9 +1,11 @@
 ---
 name: Open discussion
 about: Openly discussing this project
-title: 'discussion([context]): '
+title: "discussion([context]): "
 ---
 
+<!-- @format -->
+
 <!-- Please use [context] in title to describe the package related to this issue.
 Valid options are; Release, Label, Variable, Installer
 context example: bug(installer): {your title here}

.github/ISSUE_TEMPLATE/outdated/feature_request.md

@@ -1,9 +1,11 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: 'feat([context]): '
+title: "feat([context]): "
 ---
 
+<!-- @format -->
+
 <!-- Please use [context] in title to describe the package related to this issue.
 Valid options are; Release, Label, Variable, Installer
 context example: bug(installer): {your title here}
@@ -41,6 +43,7 @@ Include:
 <!-- Please tell us what devices should be able to do the feature. Please note that some devices may have differing capabilities depending on OS version. -->
 
 <!-- Please delete all information not relivent-->
+
 - Version: [e.g. 22]
 - Platform: [e.g. macOS, Google Cloud, ubuntu 18.04]
 - Browser: [e.g. stock browser, safari]
@@ -50,7 +53,6 @@ Include:
 - Package(s): [e.g. @videndum/release-mastermind]
 - URL: [e.g. https://console.smartcloud.gg/admin]
 
-
 ### What does success look like, and how can we measure
 
 <!-- Define both the success metrics and acceptance criteria. Note that success metrics indicate the desired business outcomes, while acceptance criteria indicate when the solution is working correctly. If there is no way to measure success, link to an issue that will implement a way to measure this. -->

.github/ISSUE_TEMPLATE/unknown.md

@@ -1,11 +1,13 @@
 ---
 name: Unknown issue type
 about: For use when other issue templates don't work for your issue
-title: '<type>([context]): '
+title: "<type>([context]): "
 ---
 
-<!-- 
-Please use <type> in title to describe the type of issue you are raising. Note that we use semantic titles in our pull requests, so where possible please stick to that format. 
+<!-- @format -->
+
+<!--
+Please use <type> in title to describe the type of issue you are raising. Note that we use semantic titles in our pull requests, so where possible please stick to that format.
 
 Please use [context] in title to describe the package related to this issue.
 Valid options are; Release, Label, Variable, Installer
@@ -17,14 +19,14 @@ context example: bug(installer): {your title here}
 <!--Literally whatever you think you need. You chose this template because all other templates didn't fit... -->
 
 <!-- Uncomment if you want to request a new issue template
-We want to make it easy for everyone to use our github, and sometime we don't have a template which works right. Here we would like you to ask you what template needs adding? 
+We want to make it easy for everyone to use our github, and sometime we don't have a template which works right. Here we would like you to ask you what template needs adding?
 
 ## Issue Template Request
 -->
 
-<!-- [META] 
+<!-- [META]
 name:
-about: 
+about:
 title:
 labels:
 assigned: