Skip to content

Commit b0fca36

Browse files
JoshuaKGoldbergJoshuaKGoldberg
committed
Initial commit ✨
0 parents  commit b0fca36

37 files changed

+3094
-0
lines changed

‎.eslintrc.cjs

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
module.exports = {
2+
extends: [
3+
"eslint:recommended",
4+
"plugin:@typescript-eslint/recommended",
5+
"plugin:@typescript-eslint/recommended-requiring-type-checking",
6+
"plugin:@typescript-eslint/strict",
7+
"prettier",
8+
],
9+
overrides: [
10+
{
11+
files: "**/*.test.ts",
12+
rules: {
13+
"@typescript-eslint/no-unsafe-assignment": "off",
14+
"@typescript-eslint/no-unsafe-call": "off",
15+
},
16+
},
17+
],
18+
parser: "@typescript-eslint/parser",
19+
parserOptions: {
20+
tsconfigRootDir: __dirname,
21+
project: ["./tsconfig.json"],
22+
},
23+
plugins: ["@typescript-eslint"],
24+
root: true,
25+
};

‎.github/CODE_OF_CONDUCT.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[email protected].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][mozilla coc].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][faq]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[mozilla coc]: https://github.com/mozilla/diversity
131+
[faq]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

‎.github/CONTRIBUTING.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Contributing
2+
3+
Thanks for your interest in contributing to `template-typescript-node-package`! 💖
4+
5+
## Code of Conduct
6+
7+
This project contains a [Contributor Covenant code of conduct](./CODE_OF_CONDUCT.md) all contributors are expected to follow.
8+
9+
## Getting Started
10+
11+
```shell
12+
git clone https://github.com/your-username/template-typescript-node-package
13+
cd template-typescript-node-package
14+
yarn
15+
```
16+
17+
## Reporting Issues
18+
19+
Please do [report an issue on the issue tracker](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues/new/choose) if there's any bugfix, documentation improvement, or general enhancement you'd like to see in the repository!
20+
Please fully fill out all required fields in the most appropriate issue form.
21+
22+
## Sending Contributions
23+
24+
Sending your own changes as contribution is always appreciated!
25+
There are two steps involved:
26+
27+
1. [Finding an Issue](#finding-an-issue)
28+
2. [Sending a Pull Request](#sending-a-pull-request)
29+
30+
### Finding an Issue
31+
32+
With the exception of very small typos, all changes to this repository generally need to correspond to an [open issue marked as `accepting prs` on the issue tracker](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aopen+is%3Aissue+label%3A%22accepting+prs%22).
33+
If this is your first time contributing, consider searching for [issues that also have the `good first issue` label](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aopen+is%3Aissue+label%3A%22accepting+prs%22+label%3A%22good+first+issue%22).
34+
If the issue you'd like to fix isn't found on the issue, see [Reporting Issues](#reporting-issues) for filing your own (please do!).
35+
36+
### Sending a Pull Request
37+
38+
Once you've identified an open issue accepting PRs that doesn't yet have a PR sent, you're free to send a pull request.
39+
Be sure to fill out the pull request template's requested information -- otherwise your PR will likely be closed.
40+
41+
PRs are also expected to have a title that adheres to [commitlint](https://github.com/conventional-changelog/commitlint).
42+
Only PR titles need to be in that format, not individual commits.
43+
Don't worry if you get this wrong: you can always change the PR title after sending it.
44+
Check [previously merged PRs](https://github.com/JoshuaKGoldberg/template-typescript-node-package/pulls?q=is%3Apr+is%3Amerged+-label%3Adependencies+) for reference.
45+
46+
Please try not to force-push commits to PRs that have already been reviewed.
47+
Doing so makes it harder to review the changes.
48+
We squash merge all commits so there's no need to try to preserve Git history within a PR branch.

‎.github/DEVELOPMENT.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
After [forking the repo from GitHub](https://help.github.com/articles/fork-a-repo):
2+
3+
```shell
4+
git clone https://github.com/<your-name-here>/template-typescript-node-package
5+
cd template-typescript-node-package
6+
yarn
7+
```

‎.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: JoshuaKGoldberg

‎.github/ISSUE_TEMPLATE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!-- Note: Please must use one of our issue templates to file an issue! 🛑 -->
2+
<!-- 👉 https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues/new/choose 👈 -->
3+
<!-- **Issues that should have been filed with a template will be closed without action, and we will ask you to use a template.** -->
4+
5+
<!-- This blank issue template is only for issues that don't fit any of the templates. -->
6+
7+
## Overview
8+
9+
...

‎.github/ISSUE_TEMPLATE/01-bug.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: "🐛 Report a Bug"
2+
description: "Report a bug trying to run the code."
3+
title: "🐛 Bug: <short description of the bug>"
4+
labels:
5+
- "type: bug"
6+
body:
7+
- attributes:
8+
description: If any of these required steps are not taken, we may not be able to review your issue. Help us to help you!
9+
label: Bug Report Checklist
10+
options:
11+
- label: I have tried restarting my IDE and the issue persists.
12+
required: true
13+
- label: I have pulled the latest `main` branch of the repository.
14+
required: true
15+
- label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aissue+label%3A%22type%3A+bug%22) and found none that matched my issue.
16+
required: true
17+
type: checkboxes
18+
- attributes:
19+
description: What did you expect to happen?
20+
label: Expected
21+
type: textarea
22+
validations:
23+
required: true
24+
- attributes:
25+
description: What happened instead?
26+
label: Actual
27+
type: textarea
28+
validations:
29+
required: true
30+
- attributes:
31+
label: Additional Info
32+
description: Any additional info you'd like to provide.
33+
type: textarea

‎.github/ISSUE_TEMPLATE/02-documentation.yaml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: "📝 Documentation"
2+
description: "Report a typo or missing area of documentation"
3+
title: "📝 Documentation: <short description of the request>"
4+
labels:
5+
- "area: documentation"
6+
body:
7+
- attributes:
8+
description: If any of these required steps are not taken, we may not be able to review your issue. Help us to help you!
9+
label: Bug Report Checklist
10+
options:
11+
- label: I have pulled the latest `main` branch of the repository.
12+
required: true
13+
- label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aissue+label%3A%22area%3A+documentation%22) and found none that matched my issue.
14+
required: true
15+
type: checkboxes
16+
- attributes:
17+
description: What would you like to report?
18+
label: Overview
19+
type: textarea
20+
validations:
21+
required: true
22+
- attributes:
23+
label: Additional Info
24+
description: Any additional info you'd like to provide.
25+
type: textarea

‎.github/ISSUE_TEMPLATE/03-feature.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: "🚀 Request a Feature"
2+
description: "Request that a new feature be added or an existing feature improved"
3+
title: "🚀 Feature: <short description of the feature>"
4+
labels:
5+
- "type: feature"
6+
body:
7+
- attributes:
8+
description: If any of these required steps are not taken, we may not be able to review your issue. Help us to help you!
9+
label: Bug Report Checklist
10+
options:
11+
- label: I have tried restarting my IDE and the issue persists.
12+
required: true
13+
- label: I have pulled the latest `main` branch of the repository.
14+
required: true
15+
- label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aissue+label%3A%22type%3A+feature%22) and found none that matched my issue.
16+
required: true
17+
type: checkboxes
18+
- attributes:
19+
description: What did you expect to be able to do?
20+
label: Overview
21+
type: textarea
22+
validations:
23+
required: true
24+
- attributes:
25+
label: Additional Info
26+
description: Any additional info you'd like to provide.
27+
type: textarea

‎.github/ISSUE_TEMPLATE/04-tooling.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: "🛠 Tooling"
2+
description: "Report a bug or request an enhancement in repository tooling"
3+
title: "🛠 Tooling: <short description of the change>"
4+
labels:
5+
- "area: tooling"
6+
body:
7+
- attributes:
8+
description: If any of these required steps are not taken, we may not be able to review your issue. Help us to help you!
9+
label: Bug Report Checklist
10+
options:
11+
- label: I have tried restarting my IDE and the issue persists.
12+
required: true
13+
- label: I have pulled the latest `main` branch of the repository.
14+
required: true
15+
- label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aissue+label%3A%22area%3A+tooling%22) and found none that matched my issue.
16+
required: true
17+
type: checkboxes
18+
- attributes:
19+
description: What did you expect to be able to do?
20+
label: Overview
21+
type: textarea
22+
validations:
23+
required: true
24+
- attributes:
25+
label: Additional Info
26+
description: Any additional info you'd like to provide.
27+
type: textarea

0 commit comments

Comments
 (0)