Migrate to "tmpl" template repository (#13)

Migrated the project setup, structure and development workflow from
version 0.9.0 [1] of the "tmpl" template repository [2].
Additionally specific assets like the repository hero image have been
replaced and documentations like the README and GitHub issue/PR
templates adjusted.

[1]: https://github.com/svengreb/tmpl/releases/tag/v0.9.0
[2]: https://github.com/svengreb/tmpl

Co-authored-by: Sven Greb <development@svengreb.de>

Closes GH-11

.editorconfig

@@ -1,6 +1,15 @@
+# Copyright (c) 2018-present Arctic Ice Studio <development@arcticicestudio.com>
+# Copyright (c) 2018-present Sven Greb <development@svengreb.de>
+# This source code is licensed under the MIT license found in the LICENSE file.
+
+# Configurations for EditorConfig.
+# See https://editorconfig.org/#file-format-details for more details.
+
 # +--------------------+
 # + Base Configuration +
 # +--------------------+
+root = true
+
 [*]
 charset = utf-8
 end_of_line = lf
@@ -14,5 +23,6 @@ trim_trailing_whitespace = true
 # + Languages +
 # +-----------+
 # +--- Markdown ---+
-[*.{md,gfm}]
+[*.{md}]
+max_line_length = off
 trim_trailing_whitespace = false

.eslintignore

@@ -0,0 +1,11 @@
+# Copyright (c) 2018-present Arctic Ice Studio <development@arcticicestudio.com>
+# Copyright (c) 2018-present Sven Greb <development@svengreb.de>
+# This source code is licensed under the MIT license found in the LICENSE file.
+
+# Path match pattern to ignore specific files and directories.
+# See https://eslint.org/docs/user-guide/configuring/ignoring-code for more details.
+
+build/*
+**/node_modules/*
+!.eslintrc.js
+!.remarkrc.js

.eslintrc.js

@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) 2018-present Arctic Ice Studio <development@arcticicestudio.com>
+ * Copyright (c) 2018-present Sven Greb <development@svengreb.de>
+ * This source code is licensed under the MIT license found in the LICENSE file.
+ */
+
+/**
+ * Configurations for ESLint.
+ *
+ * @see https://eslint.org/docs/user-guide/configuring
+ */
+module.exports = {
+  extends: [
+    "@arcticicestudio/eslint-config-base",
+    /*
+     * Enable support for projects using Prettier.
+     * Note that this must always be placed after the `@arcticicestudio/eslint-config-base` preset to take precedence,
+     * otherwise it won't prevent errors due to useless and possibly conflicting rules!
+     */
+    "@arcticicestudio/eslint-config-base/prettier",
+  ],
+};

.gitattributes

@@ -1,3 +1,19 @@
-# Automatically perform line feed (LF) normalization for files detected as text and leave all files detected as binary
-# untouched.
-* text=auto
+# Copyright (c) 2018-present Arctic Ice Studio <development@arcticicestudio.com>
+# Copyright (c) 2018-present Sven Greb <development@svengreb.de>
+# This source code is licensed under the MIT license found in the LICENSE file.
+
+# Configuration to define attributes per path.
+#
+# References:
+#   1. https://git-scm.com/docs/gitattributes
+#   2. https://git-scm.com/book/en/v2/Customizing-Git-Git-Attributes#Keyword-Expansion
+
+# Automatically perform line feed (LF) normalization for files detected as text and
+# leave all files detected as binary untouched.
+* text=auto eol=lf
+
+# +--------+
+# + Assets +
+# +--------+
+*.ai binary
+*.png binary

.github/CODEOWNERS

@@ -1,10 +1,15 @@
-# Configuration for the GitHub feature to automatically request reviews from the code owners when a pull request changes any owned files.
+# Copyright (c) 2018-present Arctic Ice Studio <development@arcticicestudio.com>
+# Copyright (c) 2018-present Sven Greb <development@svengreb.de>
+# This source code is licensed under the MIT license found in the LICENSE file.
+
+# Configuration for the GitHub feature to automatically request reviews from the code owners when a pull request
+# changes any owned files.
 #
 # References:
-#   https://github.com/blog/2392-introducing-code-owners
-#   https://help.github.com/articles/about-codeowners
+#   1. https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
+#   2. https://github.com/blog/2392-introducing-code-owners
 
 # +--------------------+
 # + Default Code Owner +
 # +--------------------+
-* @arcticicestudio
+* @arcticicestudio @svengreb

.github/ISSUE_TEMPLATE.md

@@ -1,85 +1,13 @@
 <!-- Click on the "Preview" tab to render the instructions in a more readable format -->
 
-> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-markdown/blob/develop/CONTRIBUTING.md) before filling out this issue template**.
+> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-markdown/blob/master/CONTRIBUTING.md) before filling out this issue template**.
 
-## Prerequisites
+## [Please follow one of the issue templates](https://github.com/arcticicestudio/styleguide-markdown/issues/new/choose)
 
-This section and the instructions in the sections below are only part of this issue template. Please ensure to **delete this whole section, all pre-filled instructions of the sections below and sections you have not filled out before submitting** to ensure a clear structure and overview.
+To keep the backlog clean and actionable, issues should be opened using [one the provided issue templates](https://github.com/arcticicestudio/styleguide-markdown/issues/new/choose) to help maintainers and the community to understand it, find related reports and to resolve tickets faster.
 
-Please do your best to provide as much information as possible and use a clear and descriptive title for your enhancement suggestion or bug report to help maintainers and the community understand and reproduce the behavior, find related reports and to resolve the ticket faster.
+### Support
 
-- **Ensure the issue has not already been reported by using the [GitHub Issues search](https://github.com/arcticicestudio/styleguide-markdown/issues)** — if it has **and the issue is still open**, add a comment to the existing issue instead of opening this new one. If you find a closed issue that seems to be similar to this one, include a link to the original issue in the [metadata head](#metadata-head) section of this issue.
-- **Ensure the issue is reproducible** — try to use the [latest version](https://github.com/arcticicestudio/styleguide-markdown/releases/latest) and [`develop`](https://github.com/arcticicestudio/styleguide-markdown/tree/develop) branch.
+If you got a question or need help with any aspect of the project feel free to ask and ensure to read the [extensive project documentations](https://arcticicestudio.github.io/styleguide-markdown).
 
-## Metadata Head
-
-The metadata head should be added to the top of the issue as [Markdown text quote](https://help.github.com/articles/basic-writing-and-formatting-syntax) containing the [issue type](#issue-type) and if necessary the ID of other related issues.
-
-> Issue type:
-> Related issues:
-
-### Issue Type
-
-Set the *type* of this issue. It determines which information will be required in the following sections when it is an [bug report](https://github.com/arcticicestudio/styleguide-markdown/blob/develop/CONTRIBUTING.md#bug-reports) or an [enhancement suggestion](https://github.com/arcticicestudio/styleguide-markdown/blob/develop/CONTRIBUTING.md#enhancement-suggestions).
-
-- *feature*
-- *improvement*
-- *bug*
-- *test*
-- *task*
-- *subtask*
-
-## Description
-
-Describe the enhancement or bug as in many relevant details as possible. If this is a enhancement suggestion add specific use-cases and explain why this feature or improvement would be useful. If this is a bug provide ensure to fill in the [steps to reproduce](#steps-to-reproduce) it.
-
-### Steps to Reproduce
-
-1. Step One
-2. Step Two
-3. ...
-
-### Expected Behavior
-
-What you expect to happen?
-
-### Actual Behavior
-
-What actually happens?
-
-## Example
-
-Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/styleguide-markdown/blob/develop/CONTRIBUTING.md#mcve)
-
-Note that **this is a optional section, but it can drastically increase the speed at which this issue can be processed since it takes away the time-consuming reconstruction to reproduce the enhancement or bug.**
-
-The recommened way is to upload it as [Gist](https://gist.github.com) or new repository to GitHub, but of course you can [attach it to this issue](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests), use any free file hosting service or paste the code in [Markdown code blocks](https://help.github.com/articles/basic-writing-and-formatting-syntax) into this issue.
-
-## Environment and Versions
-
-Please provide the version of Styleguide Markdown your are using and optionally include details about your configuration and environment.
-
-If possible please provide more context by answering these questions:
-
-- What is the version of *Styleguide Markdown* you are running?
-- What is the name and the version of your OS?
-  - Have you tried to reproduce it on different OS environments and if yes is the behavior the same for all?
-- If the problem is related to [Node.js](https://nodejs.org) please provide the Node.js version you're running.
-  - Are you using any additional CLI arguments for Node.js?
-- ... any additional information
-
-## Stack Trace and Error Messages
-
-```raw
-Paste the full stack trace, error messages or the logfile here ...
-```
-
-... or [attach them as files](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests) to this issue.
-
-## References
-
-Add any other references and links which are relevant for this issue.
-
-## Potential Solution
-
-If this is a bug report this might include the lines of code that you have identified as causing the bug or in case of an enhancement suggestion references to other projects where this enhancement already exists.
+You can also search for already opened and related issue using the search for the [“question“](https://github.com/arcticicestudio/styleguide-markdown/labels/type-question) issue label.

.github/ISSUE_TEMPLATE/bugs.md

@@ -0,0 +1,86 @@
+---
+name: Bug Report
+about: Report a bug that is caused by the code in this repository
+---
+
+<!-- Click on the "Preview" tab to render the instructions in a more readable format -->
+
+> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-markdown/blob/main/CONTRIBUTING.md) before filling out this issue template**.
+
+## Prerequisites
+
+This section and the instructions in the sections below are only part of this issue template. Please ensure to **delete this whole section, all pre-filled instructions of the sections below and sections you have not filled out before submitting** to ensure a clear structure and overview.
+
+Please do your best to provide as much information as possible and use a clear and descriptive title for your bug report to help maintainers and the community understand and reproduce the behavior, find related reports and to resolve the ticket faster.
+
+- **Ensure the bug has not already been reported by using the [GitHub Issues search](https://github.com/arcticicestudio/styleguide-markdown/issues)** — check if this enhancement has already been suggested. If it has **and the issue is still open**, add your additions as comment to the existing issue instead of opening a new one. If you find a closed issue that seems to be similar to this one, include a link to the original issue in the [metadata head](#metadata-head) section of this issue.
+- **Ensure the bug is reproducible and has not already been fixed** — use the [latest version](https://github.com/arcticicestudio/styleguide-markdown/releases/latest) and [`master`](https://github.com/arcticicestudio/styleguide-markdown/tree/master) branch.
+
+## Metadata Head
+
+The metadata head can be added to the top of the issue as [Markdown text quote](https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) containing the the ID of other related issues.
+
+> Related issues:
+
+## Description
+
+Describe the bug as in many relevant details as possible with a clear and concise description. Ensure to fill in the [steps to reproduce](#steps-to-reproduce) it.
+
+### Steps to Reproduce
+
+1. Step One
+2. Step Two
+3. ...
+
+### Expected Behavior
+
+What you expect to happen?
+
+### Actual Behavior
+
+What actually happens?
+
+## Example
+
+Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/styleguide-markdown/blob/main/CONTRIBUTING.md#mcve)
+
+**This is a optional section, but it can drastically increase the speed at which this issue can be processed since it takes away the time-consuming reconstruction to reproduce the bug.**
+The recommended way is to upload it as [Gist](https://gist.github.com) or new repository to GitHub, but of course you can [attach it to this issue](https://docs.github.com/en/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests), use any free file hosting service or paste the code in [Markdown code blocks](https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) into this issue.
+
+## Environment and Versions
+
+- What is the version of styleguide-markdown you are using?
+- What is the name and the version of your OS?
+  - Have you tried to reproduce it on different OS environments and if yes is the behavior the same for all?
+- If the problem is related to the runtime of the project (e.g. [Node.js](https://nodejs.org) or [Go](https://golang.org)) please provide the version you're running.
+  - Are you using any additional CLI arguments to run the project?
+- What is the version of the build tool (e.g. [npm](https://www.npmjs.com) or [Yarn](https://yarnpkg.com)) you are running?
+  - Are you using any additional CLI arguments to start the build tool task/script other than defined by the project?
+
+If you've installed [Node.js](https://nodejs.org) on your system you can run [envinfo](https://www.npmjs.com/package/envinfo) via [npx](https://blog.npmjs.org/post/162869356040/introducing-npx-an-npm-package-runner) which will print environment information that help the the community to better reproduce the bug.
+
+Run the following command **from within the project root** and paste the output in the code block below: `npx envinfo --system --system --IDEs --languages --binaries --markdown --clipboard`
+
+```md
+Paste output of the command here.
+```
+
+## Stack Trace and Error Messages
+
+```raw
+Paste the full stack trace, error messages or the logfile here.
+```
+
+... or [attach them as files](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests) to this issue.
+
+## Additional Context
+
+Add any other context, screenshots or screencasts which are relevant for this issue.
+
+## References
+
+Add any other references and links which are relevant for this issue.
+
+## Potential Solution
+
+Maybe include the lines of code that you have identified as causing the bug or references to other projects where this bug has already been reported.

.github/ISSUE_TEMPLATE/enhancement.md

@@ -0,0 +1,58 @@
+---
+name: Enhancement Suggestions
+about: Submit an enhancement suggestion for new features or minor improvements to existing functionality
+---
+
+<!-- Click on the "Preview" tab to render the instructions in a more readable format -->
+
+> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-markdown/blob/main/CONTRIBUTING.md) before filling out this issue template**.
+
+## Prerequisites
+
+This section and the instructions in the sections below are only part of this issue template. Please ensure to **delete this whole section, all pre-filled instructions of the sections below and sections you have not filled out before submitting** to ensure a clear structure and overview.
+
+Please do your best to provide as much information as possible and use a clear and descriptive title for your enhancement suggestion to help maintainers and the community understand and reproduce the behavior, find related reports and to resolve the ticket faster.
+
+- **Ensure the enhancement has not already been reported by using the [GitHub Issues search](https://github.com/arcticicestudio/styleguide-markdown/issues)** — check if this enhancement has already been suggested. If it has **and the issue is still open**, add your additions as comment to the existing issue instead of opening a new one. If you find a closed issue that seems to be similar to this one, include a link to the original issue in the [metadata head](#metadata-head) section of this issue.
+- **Check if the enhancement has already been implemented** — use the [latest version](https://github.com/arcticicestudio/styleguide-markdown/releases/latest) and [`main`](https://github.com/arcticicestudio/styleguide-markdown/tree/main) branch to ensure that the feature or improvement has not already been added.
+
+## Metadata Head
+
+The metadata head can be added to the top of the issue as [Markdown text quote](https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) containing the ID of other related issues.
+
+> Related issues:
+
+## Description
+
+Describe the enhancement in many relevant details as possible.
+
+### Benefits
+
+Add specific use-cases and explain why this feature or improvement would be useful and maybe include references to related known problems or bug reports.
+
+### Possible Drawbacks
+
+Describe possible negative impacts regarding e.g. functionality or usability.
+
+### Alternative Solutions
+
+If you've considered alternative features or solutions please describe it clearly and concise.
+
+## Example
+
+Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/styleguide-markdown/blob/main/CONTRIBUTING.md#mcve)
+
+**This is a optional section, but it can drastically increase the speed at which this issue can be processed since it takes away the time-consuming reconstruction to reproduce the enhancement.**
+The recommended way is to upload it as [Gist](https://gist.github.com) or new repository to GitHub, but of course you can [attach it to this issue](https://docs.github.com/en/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests), use any free file hosting service or paste the code in [Markdown code blocks](https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) into this issue.
+
+## Additional Context
+
+Add any other context, screenshots or screencasts which are relevant for this issue.
+
+## References
+
+Add any other references and links which are relevant for this issue.
+
+## Potential Solution
+
+Maybe include references to other projects where this enhancement already exists.