Update GitHub documentation and meta.

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement using any of the [private contact addresses](https://github.com/russelporosky/ts-boilerplate#support).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md → .github/CONTRIBUTING.md

@@ -16,7 +16,7 @@ To set up a development environment, please follow these steps:
 2. Install dependencies
 
    ```shell
-   npm install 
+   npm ci 
    ```
 
 3. Run tests

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a report to help the boilerplate improve
+title: '[BUG]'
+labels: bug
+assignees: russelporosky
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Add code `...`
+2. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+- OS: [e.g. iOS]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+    - name: GitHub discussions
+      url: https://github.com/russelporosky/ts-boilerplate/discussions
+      about: Please ask and answer questions here.
+    - name: Vulnerability advisory
+      url: https://github.com/russelporosky/ts-boilerplate/security/advisories
+      about: Please privately inform me of security issues here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Bug report
+about: Suggest an idea for the boilerplate
+title: '[FEATURE]'
+labels: enhancement
+assignees: russelporosky
+
+---
+
+**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 the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**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.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+<!--
+  Please check the needed checkboxes ([ ] -> [x]). Leave the comments as they are, they won’t show on GitHub.
+  Pull requests are awesome, but please try to limit the scope and provide a general description of the changes.
+-->
+
+### Initial checklist
+
+*   [ ] I read the support docs <!-- https://github.com/remarkjs/.github/blob/main/support.md -->
+*   [ ] I read the contributing guide <!-- https://github.com/remarkjs/.github/blob/main/contributing.md -->
+*   [ ] I agree to follow the code of conduct <!-- https://github.com/remarkjs/.github/blob/main/code-of-conduct.md -->
+*   [ ] I searched issues and couldn’t find anything (or linked relevant results below) <!-- https://github.com/search?q=user%3Aremarkjs&type=Issues -->
+*   [ ] If applicable, I’ve added docs and tests
+
+### Description of changes
+
+Describe the changes in this PR.

.github/SUPPORT.md

@@ -0,0 +1,30 @@
+# Support
+
+This document explains where to get help with ts-boilerplate. Please read through the following guidelines.
+
+> Before participating, please read the [code of conduct](CODE_OF_CONDUCT.md). By interacting with this repository you agree to abide by its terms.
+
+## Asking quality questions
+
+Questions can go to [GitHub discussions](https://github.com/russelporosky/ts-boilerplate/discussions).
+
+Help me help you! Spend time framing questions and add links and resources. Spending the extra time up front can help save everyone time in the long run. Here are some tips:
+
+*   [Talk to a duck](https://rubberduckdebugging.com)!
+*   Don’t fall for the [XY problem](https://meta.stackexchange.com/questions/66377/what-is-the-xy-problem/66378#66378)
+*   Search to find out if a similar question has been asked
+*   Try to define what you need help with:
+	*   Is there something in particular you want to do?
+	*   What problem are you encountering and what steps have you taken to try and fix it?
+	*   Is there a concept you don’t understand?
+*   Provide sample code or video, if possible
+*   Screenshots can help, but if there’s important text such as code or error messages in them, please also provide those as text
+*   The more time you put into asking your question, the better I can help you
+
+## Contributions
+
+See [`contributing.md`](CONTRIBUTING.md) on how to contribute.
+
+## License
+
+[MIT](../LICENSE) © [Russel Porosky](https://github.com/russelporosky/)

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: 'npm'
+    directory: /
+    schedule:
+      interval: weekly

.github/workflows/ci.yml

@@ -13,8 +13,8 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+        node-version: [18.x, 20.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/previous-releases/
 
     steps:
       - uses: actions/checkout@v3

CITATION.cff

@@ -0,0 +1,23 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: TypeScript Boilerplate
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - orcid: 'https://orcid.org/0009-0007-1865-1775'
+    given-names: Russel
+    family-names: Porosky
+    email: [email protected]
+repository-code: 'https://github.com/russelporosky/ts-boilerplate/'
+url: 'https://github.com/russelporosky/ts-boilerplate/'
+abstract: A lightweight TypeScript boilerplate for TDD.
+keywords:
+  - typescript
+  - tdd
+  - boilerplate
+  - javascript
+license: MIT

LICENSE

@@ -1,5 +1,5 @@
 The MIT License (MIT)
-Copyright © 2021 <copyright holders>
+Copyright © 2023 Russel Porosky
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -1,6 +1,9 @@
 # TypeScript Boilerplate
 
+[![GitHub Release](https://img.shields.io/github/release/russelporosky/ts-boilerplate.svg?style=flat)]()
 [![Build Status](https://github.com/russelporosky/ts-boilerplate/actions/workflows/ci.yml/badge.svg)](https://github.com/russelporosky/ts-boilerplate/actions)
+[![Issues](https://img.shields.io/github/issues-raw/russelporosky/ts-boilerplate.svg?maxAge=25000)](https://github.com/russelporosky/ts-boilerplate/issues)
+[![GitHub pull requests](https://img.shields.io/github/issues-pr/russelporosky/ts-boilerplate.svg?style=flat)]()
 
 This is a lightweight TypeScript boilerplate that uses `jest` for testing, `prettier` for formatting, and `typedoc` for document generation.
 
@@ -15,13 +18,13 @@ Delete or rename the existing `src/HelloWorld.ts` and `src/HelloWorld.spec.ts` f
 Reach out to the maintainer at one of the following places:
 
 - [GitHub discussions](https://github.com/russelporosky/ts-boilerplate/discussions)
-- The email which is located [in my GitHub profile](https://github.com/russelporosky)
+- [Private vulnerability disclosure](https://github.com/russelporosky/ts-boilerplate/security/advisories)
 
 ## Contributing
 
 First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are **greatly appreciated**.
 
-We have set up a separate document containing our [contribution guidelines](CONTRIBUTING.md).
+We have set up a separate document containing our [contribution guidelines](.github/CONTRIBUTING.md).
 
 Thank you for being involved!
 
@@ -36,7 +39,7 @@ For a full list of all authors and contributors, check [the contributor's page](
 TS-Boilerplate follows good practices of security, but 100% security can't be granted in software.
 TS-Boilerplate is provided **"as is"** without any **warranty**. Use at your own risk.
 
-_For more info, please refer to the [security](SECURITY.md)._
+_For more info, please refer to the [security](.github/SECURITY.md)._
 
 ## License
 

coverage/lcov-report/HelloWorld.ts.html

@@ -136,7 +136,7 @@ <h1><a href="index.html">All files</a> HelloWorld.ts</h1>
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2023-09-25T17:05:27.823Z
+                at 2023-10-28T01:22:42.314Z
             </div>
         <script src="prettify.js"></script>
         <script>

coverage/lcov-report/index.html

@@ -101,7 +101,7 @@ <h1>All files</h1>
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2023-09-25T17:05:27.823Z
+                at 2023-10-28T01:22:42.314Z
             </div>
         <script src="prettify.js"></script>
         <script>