Skip to content

Commit 3ad6145

Browse files
tenthirtyamtenthirtyam
committed
chore: initial commit
Initial commit. Signed-off-by: Ryan Johnson <ryan@tenthirtyam.org>
0 parents  commit 3ad6145

57 files changed

Lines changed: 92521 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.eslintrc.json‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"plugins": ["@typescript-eslint", "jest"],
3+
"extends": [
4+
"eslint:recommended",
5+
"plugin:@typescript-eslint/recommended",
6+
"plugin:jest/recommended"
7+
],
8+
"parser": "@typescript-eslint/parser",
9+
"parserOptions": {
10+
"ecmaVersion": 2022,
11+
"sourceType": "module",
12+
"project": "./tsconfig.json"
13+
},
14+
"rules": {
15+
"no-console": "error",
16+
"@typescript-eslint/no-explicit-any": "warn",
17+
"@typescript-eslint/explicit-function-return-type": "warn",
18+
"no-unused-vars": "off",
19+
"@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_" }],
20+
"@typescript-eslint/no-floating-promises": "error",
21+
"@typescript-eslint/await-thenable": "error",
22+
"@typescript-eslint/no-misused-promises": "error"
23+
},
24+
"env": {
25+
"node": true,
26+
"jest": true
27+
},
28+
"ignorePatterns": [
29+
"dist",
30+
"node_modules",
31+
"coverage"
32+
],
33+
"root": true
34+
}

‎.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 email 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+
[hello@tenthirtyam.org][enforcement]. All complaints will be reviewed and
64+
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][cc], version
118+
[v2.1][cc-v2.1].
119+
120+
Community Impact Guidelines were inspired by Mozilla's
121+
[Code of Conduct Enforcement][mozilla-coce] consequence ladder.
122+
123+
For answers to common questions about this code of conduct, please refer to the
124+
[Frequently Asked Questions][cc-faq]. Translations are available in
125+
[additional languages][cc-translations].
126+
127+
[cc]: https://www.contributor-covenant.org
128+
[cc-faq]: https://www.contributor-covenant.org/faq/
129+
[cc-translations]: https://www.contributor-covenant.org/translations/
130+
[cc-v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct/
131+
[enforcement]: mailto:hello@tenthirtyam.org?subject=Open%20Source%20Code%20of%20Conduct
132+
[mozilla-coce]: https://github.com/mozilla/inclusion/

‎.github/CODEOWNERS‎

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

‎.github/CONTRIBUTING.md‎

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
# Contributing Guidelines
2+
3+
Thank you for your interest in contributing to our project. Whether it's a bug
4+
report, new feature, correction, or additional documentation, we greatly value
5+
feedback and contributions from our community.
6+
7+
Please read through this document before submitting any issues or pull requests
8+
to ensure we have all the necessary information to effectively respond to your
9+
bug report or contribution.
10+
11+
## Reporting Bugs and Suggesting Enhancements
12+
13+
We welcome you to use the [GitHub issues][gh-issues] to report bugs or suggest
14+
enhancements.
15+
16+
When filing an issue, please check existing open, or recently closed, issues to
17+
make sure someone else hasn't already reported.
18+
19+
Please try to include as much information as you can using the issue fo. Details
20+
like these are incredibly useful:
21+
22+
- A reproducible test case or series of steps.
23+
- Any modifications you've made relevant to the bug.
24+
- Anything unusual about your environment or deployment.
25+
26+
## Contributing via Pull Requests
27+
28+
Contributions using pull requests are appreciated.
29+
30+
**Before** sending us a pull request, please ensure that:
31+
32+
1. You check existing open, and recently merged, pull requests to make sure
33+
someone else hasn't already addressed the problem.
34+
2. You [open a discussion][gh-discussions] to discuss any significant work with
35+
the maintainer(s).
36+
3. You [open an issue][gh-issues] and link your pull request to the issue for
37+
context. Pull requests without an accompanying issue will be closed.
38+
4. You are working against the latest source on the `main` branch.
39+
40+
To open a pull request, please:
41+
42+
1. Fork the repository.
43+
2. Modify the source; please focus on the **specific** change you are
44+
contributing.
45+
3. Ensure local tests pass.
46+
4. Updated the documentation, if required.
47+
5. Sign-off and commit to your fork
48+
[using a clear commit messages][git-commit]. Use of
49+
[Conventional Commits][conventional-commits] are required.
50+
6. Open a pull request, answering any default questions.
51+
7. Pay attention to any automated failures reported in the pull request, and
52+
stay involved in the conversation.
53+
54+
GitHub provides additional documentation on [forking a repository][gh-forks] and
55+
[creating a pull request][gh-pull-requests].
56+
57+
### Contributor Flow
58+
59+
This is an outline of the contributor workflow:
60+
61+
- Create a topic branch from where you want to base your work.
62+
- Make commits of logical units.
63+
- Make sure your commit messages are
64+
[in the proper format][conventional-commits] **and** are signed-off.
65+
- Push your changes to the topic branch in your fork.
66+
- Submit a pull request. If the pull request is a work in progress, open as
67+
draft until ready for review.
68+
69+
> [!IMPORTANT] This project **requires** that commits are signed-off for the
70+
> [Developer Certificate of Origin][dco].
71+
72+
Example:
73+
74+
```shell
75+
git remote add upstream https://github.com/<org-name>/<repo-name>.git
76+
git checkout --branch feat/add-x main
77+
git commit --signoff --message "feat: add support for x
78+
Added support for x.
79+
80+
Signed-off-by: Jane Doe <jdoe@example.com>
81+
82+
Ref: #123"
83+
git push origin feat/add-x
84+
```
85+
86+
### Formatting Commit Messages
87+
88+
We follow the conventions on [How to Write a Git Commit Message][git-commit] and
89+
[Conventional Commits][conventional-commits].
90+
91+
Be sure to include any related GitHub issue references in the commit message.
92+
93+
Example:
94+
95+
```markdown
96+
feat: add support for x
97+
98+
Added support for x.
99+
100+
Signed-off-by: Jane Doe <jdoe@example.com>
101+
102+
Ref: #123
103+
```
104+
105+
### Staying In Sync With Upstream
106+
107+
When your branch gets out of sync with the `tenthirtyam/main` branch, use the
108+
following to update:
109+
110+
```shell
111+
git checkout feat/add-x
112+
git fetch --all
113+
git pull --rebase upstream main
114+
git push --force-with-lease origin feat/add-x
115+
```
116+
117+
### Updating Pull Requests
118+
119+
If your pull request fails to pass or needs changes based on code review, you'll
120+
most likely want to squash these changes into existing commits.
121+
122+
If your pull request contains a single commit or your changes are related to the
123+
most recent commit, you can simply amend the commit.
124+
125+
```shell
126+
git add .
127+
git commit --amend
128+
git push --force-with-lease origin feat/add-x
129+
```
130+
131+
If you need to squash changes into an earlier commit, you can use:
132+
133+
```shell
134+
git add .
135+
git commit --fixup <commit>
136+
git rebase --interactive --autosquash main
137+
git push --force-with-lease origin feat/add-x
138+
```
139+
140+
Be sure to add a comment to the pull request indicating your new changes are
141+
ready to review, as GitHub does not generate a notification when you `git push`.
142+
143+
## Finding Contributions to Work On
144+
145+
Looking at the existing issues is a great way to find something to contribute
146+
on. If you have an idea you'd like to discuss,
147+
[open a discussion][gh-discussions].
148+
149+
[dco]: https://probot.github.io/apps/dco/
150+
[conventional-commits]: https://conventionalcommits.org
151+
[gh-discussions]: https://github.com/tenthirtyam/setup-task/discussions
152+
[gh-forks]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo
153+
[gh-issues]: https://github.com/tenthirtyam/setup-task/issues
154+
[gh-markdown]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github
155+
[gh-pull-requests]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
156+
[git-commit]: https://cbea.ms/git-commit
157+
[license]: LICENSE

0 commit comments

Comments
 (0)