···11+# Contributor Covenant Code of Conduct
22+33+## Our Pledge
44+55+We as members, contributors, and leaders pledge to make participation in our
66+community a harassment-free experience for everyone, regardless of age, body
77+size, visible or invisible disability, ethnicity, sex characteristics, gender
88+identity and expression, level of experience, education, socio-economic status,
99+nationality, personal appearance, race, caste, color, religion, or sexual
1010+identity and orientation.
1111+1212+We pledge to act and interact in ways that contribute to an open, welcoming,
1313+diverse, inclusive, and healthy community.
1414+1515+## Our Standards
1616+1717+Examples of behavior that contributes to a positive environment for our
1818+community include:
1919+2020+- Demonstrating empathy and kindness toward other people
2121+- Being respectful of differing opinions, viewpoints, and experiences
2222+- Giving and gracefully accepting constructive feedback
2323+- Accepting responsibility and apologizing to those affected by our mistakes,
2424+ and learning from the experience
2525+- Focusing on what is best not just for us as individuals, but for the overall
2626+ community
2727+2828+Examples of unacceptable behavior include:
2929+3030+- The use of sexualized language or imagery, and sexual attention or advances of
3131+ any kind
3232+- Trolling, insulting or derogatory comments, and personal or political attacks
3333+- Public or private harassment
3434+- Publishing others' private information, such as a physical or email address,
3535+ without their explicit permission
3636+- Other conduct which could reasonably be considered inappropriate in a
3737+ professional setting
3838+3939+## Enforcement Responsibilities
4040+4141+Community leaders are responsible for clarifying and enforcing our standards of
4242+acceptable behavior and will take appropriate and fair corrective action in
4343+response to any behavior that they deem inappropriate, threatening, offensive,
4444+or harmful.
4545+4646+Community leaders have the right and responsibility to remove, edit, or reject
4747+comments, commits, code, wiki edits, issues, and other contributions that are
4848+not aligned to this Code of Conduct, and will communicate reasons for moderation
4949+decisions when appropriate.
5050+5151+## Scope
5252+5353+This Code of Conduct applies within all community spaces, and also applies when
5454+an individual is officially representing the community in public spaces.
5555+Examples of representing our community include using an official e-mail address,
5656+posting via an official social media account, or acting as an appointed
5757+representative at an online or offline event.
5858+5959+## Enforcement
6060+6161+Instances of abusive, harassing, or otherwise unacceptable behavior may be
6262+reported to the community leaders responsible for enforcement at
6363+26290074+tylersayshi@users.noreply.github.com.
6464+All complaints will be reviewed and investigated promptly and fairly.
6565+6666+All community leaders are obligated to respect the privacy and security of the
6767+reporter of any incident.
6868+6969+## Enforcement Guidelines
7070+7171+Community leaders will follow these Community Impact Guidelines in determining
7272+the consequences for any action they deem in violation of this Code of Conduct:
7373+7474+### 1. Correction
7575+7676+**Community Impact**: Use of inappropriate language or other behavior deemed
7777+unprofessional or unwelcome in the community.
7878+7979+**Consequence**: A private, written warning from community leaders, providing
8080+clarity around the nature of the violation and an explanation of why the
8181+behavior was inappropriate. A public apology may be requested.
8282+8383+### 2. Warning
8484+8585+**Community Impact**: A violation through a single incident or series of
8686+actions.
8787+8888+**Consequence**: A warning with consequences for continued behavior. No
8989+interaction with the people involved, including unsolicited interaction with
9090+those enforcing the Code of Conduct, for a specified period of time. This
9191+includes avoiding interactions in community spaces as well as external channels
9292+like social media. Violating these terms may lead to a temporary or permanent
9393+ban.
9494+9595+### 3. Temporary Ban
9696+9797+**Community Impact**: A serious violation of community standards, including
9898+sustained inappropriate behavior.
9999+100100+**Consequence**: A temporary ban from any sort of interaction or public
101101+communication with the community for a specified period of time. No public or
102102+private interaction with the people involved, including unsolicited interaction
103103+with those enforcing the Code of Conduct, is allowed during this period.
104104+Violating these terms may lead to a permanent ban.
105105+106106+### 4. Permanent Ban
107107+108108+**Community Impact**: Demonstrating a pattern of violation of community
109109+standards, including sustained inappropriate behavior, harassment of an
110110+individual, or aggression toward or disparagement of classes of individuals.
111111+112112+**Consequence**: A permanent ban from any sort of public interaction within the
113113+community.
114114+115115+## Attribution
116116+117117+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118118+version 2.1, available at
119119+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120120+121121+Community Impact Guidelines were inspired by
122122+[Mozilla's code of conduct enforcement ladder][mozilla coc].
123123+124124+For answers to common questions about this code of conduct, see the FAQ at
125125+[https://www.contributor-covenant.org/faq][faq]. Translations are available at
126126+[https://www.contributor-covenant.org/translations][translations].
127127+128128+[homepage]: https://www.contributor-covenant.org
129129+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130130+[mozilla coc]: https://github.com/mozilla/diversity
131131+[faq]: https://www.contributor-covenant.org/faq
132132+[translations]: https://www.contributor-covenant.org/translations
+97
.github/CONTRIBUTING.md
···11+# Contributing
22+33+Thanks for your interest in contributing to `prototypey`! 💖
44+55+> After this page, see [DEVELOPMENT.md](./DEVELOPMENT.md) for local development instructions.
66+77+## Code of Conduct
88+99+This project contains a [Contributor Covenant code of conduct](./CODE_OF_CONDUCT.md) all contributors are expected to follow.
1010+1111+## Reporting Issues
1212+1313+Please do [report an issue on the issue tracker](https://github.com/tylersayshi/prototypey/issues/new/choose) if there's any bugfix, documentation improvement, or general enhancement you'd like to see in the repository! Please fully fill out all required fields in the most appropriate issue form.
1414+1515+## Sending Contributions
1616+1717+Sending your own changes as contribution is always appreciated!
1818+There are two steps involved:
1919+2020+1. [Finding an Issue](#finding-an-issue)
2121+2. [Sending a Pull Request](#sending-a-pull-request)
2222+2323+### Finding an Issue
2424+2525+With the exception of very small typos, all changes to this repository generally need to correspond to an [unassigned open issue marked as `status: accepting prs` on the issue tracker](https://github.com/tylersayshi/prototypey/issues?q=is%3Aissue+is%3Aopen+label%3A%22status%3A+accepting+prs%22+no%3Aassignee+).
2626+If this is your first time contributing, consider searching for [unassigned issues that also have the `good first issue` label](https://github.com/tylersayshi/prototypey/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3A%22status%3A+accepting+prs%22+no%3Aassignee+).
2727+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!).
2828+2929+#### Issue Claiming
3030+3131+We don't use any kind of issue claiming system.
3232+We've found in the past that they result in accidental ["licked cookie"](https://devblogs.microsoft.com/oldnewthing/20091201-00/?p=15843) situations where contributors claim an issue but run out of time or energy trying before sending a PR.
3333+3434+If an unassigned issue has been marked as `status: accepting prs` and an open PR does not exist, feel free to send a PR.
3535+Please don't post comments asking for permission or stating you will work on an issue.
3636+3737+### Sending a Pull Request
3838+3939+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.
4040+Be sure to fill out the pull request template's requested information -- otherwise your PR will likely be closed.
4141+4242+PRs are also expected to have a title that adheres to [conventional commits](https://www.conventionalcommits.org/en/v1.0.0).
4343+Only PR titles need to be in that format, not individual commits.
4444+Don't worry if you get this wrong: you can always change the PR title after sending it.
4545+Check [previously merged PRs](https://github.com/tylersayshi/prototypey/pulls?q=is%3Apr+is%3Amerged+-label%3Adependencies+) for reference.
4646+4747+#### Draft PRs
4848+4949+If you don't think your PR is ready for review, [set it as a draft](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft).
5050+Draft PRs won't be reviewed.
5151+5252+#### Granular PRs
5353+5454+Please keep pull requests single-purpose: in other words, don't attempt to solve multiple unrelated problems in one pull request.
5555+Send one PR per area of concern.
5656+Multi-purpose pull requests are harder and slower to review, block all changes from being merged until the whole pull request is reviewed, and are difficult to name well with semantic PR titles.
5757+5858+#### Pull Request Reviews
5959+6060+When a PR is not in draft, it's considered ready for review.
6161+Please don't manually `@` tag anybody to request review.
6262+A maintainer will look at it when they're next able to.
6363+6464+PRs should have passing [GitHub status checks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks) before review is requested (unless there are explicit questions asked in the PR about any failures).
6565+6666+#### Asking Questions
6767+6868+If you need help and/or have a question, posting a comment in the PR is a great way to do so.
6969+There's no need to tag anybody individually.
7070+One of us will drop by and help when we can.
7171+7272+Please post comments as [line comments](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request) when possible, so that they can be threaded.
7373+You can [resolve conversations](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#resolving-conversations) on your own when you feel they're resolved - no need to comment explicitly and/or wait for a maintainer.
7474+7575+#### Requested Changes
7676+7777+After a maintainer reviews your PR, they may request changes on it.
7878+Once you've made those changes, [re-request review on GitHub](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews#re-requesting-a-review).
7979+8080+Please try not to force-push commits to PRs that have already been reviewed.
8181+Doing so makes it harder to review the changes.
8282+We squash merge all commits so there's no need to try to preserve Git history within a PR branch.
8383+8484+Once you've addressed all our feedback by making code changes and/or started a followup discussion, [re-request review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews#re-requesting-a-review) from each maintainer whose feedback you addressed.
8585+8686+Once all feedback is addressed and the PR is approved, we'll ensure the branch is up to date with `main` and merge it for you.
8787+8888+#### Post-Merge Recognition
8989+9090+Once your PR is merged, if you haven't yet been added to the [_Contributors_ table in the README.md](../README.md#contributors) for its [type of contribution](https://allcontributors.org/docs/en/emoji-key "Allcontributors emoji key"), you should be soon.
9191+Please do ping the maintainer who merged your PR if that doesn't happen within 24 hours - it was likely an oversight on our end!
9292+9393+## Emojis & Appreciation
9494+9595+If you made it all the way to the end, bravo dear user, we love you.
9696+Please include an emoji in the bottom of your issues and PRs to signal to us that you did in fact read this file and are trying to conform to it as best as possible.
9797+💖 is a good starter if you're not sure which to use.
+67
.github/DEVELOPMENT.md
···11+# Development
22+33+After [forking the repo from GitHub](https://help.github.com/articles/fork-a-repo) and [installing pnpm](https://pnpm.io/installation):
44+55+```shell
66+git clone https://github.com/(your-name-here)/prototypey
77+cd prototypey
88+pnpm install
99+```
1010+1111+## Building
1212+1313+Run [**tsdown**](https://tsdown.dev) locally to build source files from `src/` into output files in `lib/`:
1414+1515+```shell
1616+pnpm build
1717+```
1818+1919+Add `--watch` to run the builder in a watch mode that continuously cleans and recreates `lib/` as you save files:
2020+2121+```shell
2222+pnpm build --watch
2323+```
2424+2525+## Formatting
2626+2727+[Prettier](https://prettier.io) is used to format code.
2828+It should be applied automatically when you save files in VS Code or make a Git commit.
2929+3030+To manually reformat all files, you can run:
3131+3232+```shell
3333+pnpm format --write
3434+```
3535+3636+## Linting
3737+3838+This package includes several forms of linting to enforce consistent code quality and styling.
3939+Each should be shown in VS Code, and can be run manually on the command-line:
4040+4141+- `pnpm lint` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints JavaScript and TypeScript source files
4242+4343+Read the individual documentation for each linter to understand how it can be configured and used best.
4444+4545+For example, ESLint can be run with `--fix` to auto-fix some lint rule complaints:
4646+4747+```shell
4848+pnpm run lint --fix
4949+```
5050+5151+Note that you'll need to run `pnpm build` before `pnpm lint` so that lint rules which check the file system can pick up on any built files.
5252+5353+## Type Checking
5454+5555+You should be able to see suggestions from [TypeScript](https://typescriptlang.org) in your editor for all open files.
5656+5757+However, it can be useful to run the TypeScript command-line (`tsc`) to type check all files in `src/`:
5858+5959+```shell
6060+pnpm tsc
6161+```
6262+6363+Add `--watch` to keep the type checker running in a watch mode that updates the display as you save files:
6464+6565+```shell
6666+pnpm tsc --watch
6767+```
+9
.github/ISSUE_TEMPLATE.md
···11+<!-- Note: Please must use one of our issue templates to file an issue! 🛑 -->
22+<!-- 👉 https://github.com/tylersayshi/prototypey/issues/new/choose 👈 -->
33+<!-- **Issues that should have been filed with a template will be closed without action, and we will ask you to use a template.** -->
44+55+<!-- This blank issue template is only for issues that don't fit any of the templates. -->
66+77+## Overview
88+99+...
+37
.github/ISSUE_TEMPLATE/01-bug.yml
···11+body:
22+ - attributes:
33+ description: If any of these required steps are not taken, we may not be able to review your issue. Help us to help you!
44+ label: Bug Report Checklist
55+ options:
66+ - label: I have tried restarting my IDE and the issue persists.
77+ required: true
88+ - label: I have pulled the latest `main` branch of the repository.
99+ required: true
1010+ - label: I have [searched for related issues](https://github.com/tylersayshi/prototypey/issues?q=is%3Aissue) and found none that matched my issue.
1111+ required: true
1212+ type: checkboxes
1313+ - attributes:
1414+ description: What did you expect to happen?
1515+ label: Expected
1616+ type: textarea
1717+ validations:
1818+ required: true
1919+ - attributes:
2020+ description: What happened instead?
2121+ label: Actual
2222+ type: textarea
2323+ validations:
2424+ required: true
2525+ - attributes:
2626+ description: Any additional info you'd like to provide.
2727+ label: Additional Info
2828+ type: textarea
2929+3030+description: Report a bug trying to run the code
3131+3232+labels:
3333+ - "type: bug"
3434+3535+name: 🐛 Bug
3636+3737+title: "🐛 Bug: <short description of the bug>"
+29
.github/ISSUE_TEMPLATE/02-documentation.yml
···11+body:
22+ - attributes:
33+ description: If any of these required steps are not taken, we may not be able to review your issue. Help us to help you!
44+ label: Documentation Report Checklist
55+ options:
66+ - label: I have pulled the latest `main` branch of the repository.
77+ required: true
88+ - label: I have [searched for related issues](https://github.com/tylersayshi/prototypey/issues?q=is%3Aissue) and found none that matched my issue.
99+ required: true
1010+ type: checkboxes
1111+ - attributes:
1212+ description: What would you like to report?
1313+ label: Overview
1414+ type: textarea
1515+ validations:
1616+ required: true
1717+ - attributes:
1818+ description: Any additional info you'd like to provide.
1919+ label: Additional Info
2020+ type: textarea
2121+2222+description: Report a typo or missing area of documentation
2323+2424+labels:
2525+ - "area: documentation"
2626+2727+name: 📝 Documentation
2828+2929+title: "📝 Documentation: <short description of the request>"
+29
.github/ISSUE_TEMPLATE/03-feature.yml
···11+body:
22+ - attributes:
33+ description: If any of these required steps are not taken, we may not be able to review your issue. Help us to help you!
44+ label: Feature Request Checklist
55+ options:
66+ - label: I have pulled the latest `main` branch of the repository.
77+ required: true
88+ - label: I have [searched for related issues](https://github.com/tylersayshi/prototypey/issues?q=is%3Aissue) and found none that matched my issue.
99+ required: true
1010+ type: checkboxes
1111+ - attributes:
1212+ description: What did you expect to be able to do?
1313+ label: Overview
1414+ type: textarea
1515+ validations:
1616+ required: true
1717+ - attributes:
1818+ description: Any additional info you'd like to provide.
1919+ label: Additional Info
2020+ type: textarea
2121+2222+description: Request that a new feature be added or an existing feature improved
2323+2424+labels:
2525+ - "type: feature"
2626+2727+name: 🚀 Feature
2828+2929+title: "🚀 Feature: <short description of the feature>"
+31
.github/ISSUE_TEMPLATE/04-tooling.yml
···11+body:
22+ - attributes:
33+ description: If any of these required steps are not taken, we may not be able to review your issue. Help us to help you!
44+ label: Tooling Report Checklist
55+ options:
66+ - label: I have tried restarting my IDE and the issue persists.
77+ required: true
88+ - label: I have pulled the latest `main` branch of the repository.
99+ required: true
1010+ - label: I have [searched for related issues](https://github.com/tylersayshi/prototypey/issues?q=is%3Aissue) and found none that matched my issue.
1111+ required: true
1212+ type: checkboxes
1313+ - attributes:
1414+ description: What did you expect to be able to do?
1515+ label: Overview
1616+ type: textarea
1717+ validations:
1818+ required: true
1919+ - attributes:
2020+ description: Any additional info you'd like to provide.
2121+ label: Additional Info
2222+ type: textarea
2323+2424+description: Report a bug or request an enhancement in repository tooling
2525+2626+labels:
2727+ - "area: tooling"
2828+2929+name: 🛠 Tooling
3030+3131+title: "🛠 Tooling: <short description of the change>"
+13
.github/PULL_REQUEST_TEMPLATE.md
···11+<!-- 👋 Hi, thanks for sending a PR to prototypey! 💖
22+Please fill out all fields below and make sure each item is true and [x] checked.
33+Otherwise we may not be able to review your PR. -->
44+55+## PR Checklist
66+77+- [ ] Addresses an existing open issue: fixes #000
88+- [ ] That issue was marked as [`status: accepting prs`](https://github.com/tylersayshi/prototypey/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
99+- [ ] Steps in [CONTRIBUTING.md](https://github.com/tylersayshi/prototypey/blob/main/.github/CONTRIBUTING.md) were taken
1010+1111+## Overview
1212+1313+<!-- Description of what is changed and how the code change does that. -->
+9
.github/SECURITY.md
···11+# Security Policy
22+33+We take all security vulnerabilities seriously.
44+If you have a vulnerability or other security issues to disclose:
55+66+- Thank you very much, please do!
77+- Please send them to us by emailing `26290074+tylersayshi@users.noreply.github.com`
88+99+We appreciate your efforts and responsible disclosure and will make every effort to acknowledge your contributions.
···11-# This workflow uses actions that are not certified by GitHub.
22-# They are provided by a third-party and are governed by
33-# separate terms of service, privacy policy, and support
44-# documentation.
55-66-# This workflow will install Deno then run `deno lint` and `deno test`.
77-# For more information see: https://github.com/denoland/setup-deno
88-99-name: Deno
1010-1111-on:
1212- push:
1313- branches: ["main"]
1414- pull_request:
1515- branches: ["main"]
1616-1717-permissions:
1818- contents: read
1919-2020-jobs:
2121- test:
2222- runs-on: ubuntu-latest
2323-2424- steps:
2525- - name: Setup repo
2626- uses: actions/checkout@v4
2727-2828- - name: Setup Deno
2929- uses: denoland/setup-deno@v1
3030- with:
3131- deno-version: v2.x
3232-3333- - name: Verify formatting
3434- run: deno fmt --check
3535-3636- - name: Run linter
3737- run: deno lint
3838-3939- - name: Run type checker
4040- run: deno check
4141-4242- - name: Run tests
4343- run: deno test -A
···11+# MIT License
22+33+Permission is hereby granted, free of charge, to any person obtaining
44+a copy of this software and associated documentation files (the
55+'Software'), to deal in the Software without restriction, including
66+without limitation the rights to use, copy, modify, merge, publish,
77+distribute, sublicense, and/or sell copies of the Software, and to
88+permit persons to whom the Software is furnished to do so, subject to
99+the following conditions:
1010+1111+The above copyright notice and this permission notice shall be
1212+included in all copies or substantial portions of the Software.
1313+1414+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
1515+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
1616+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
1717+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
1818+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
1919+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
2020+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+33
create-typescript-app.md
···11+<h1 align="center">Prototypey</h1>
22+33+<p align="center">
44+ A very lovely package.
55+ Hooray!
66+</p>
77+88+<p align="center">
99+ <a href="https://github.com/tylersayshi/prototypey/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="🤝 Code of Conduct: Kept" src="https://img.shields.io/badge/%F0%9F%A4%9D_code_of_conduct-kept-21bb42" /></a>
1010+ <a href="https://github.com/tylersayshi/prototypey/blob/main/LICENSE.md" target="_blank"><img alt="📝 License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg" /></a>
1111+ <img alt="💪 TypeScript: Strict" src="https://img.shields.io/badge/%F0%9F%92%AA_typescript-strict-21bb42.svg" />
1212+</p>
1313+1414+## Usage
1515+1616+```shell
1717+npm i prototypey
1818+```
1919+2020+```ts
2121+import { greet } from "prototypey";
2222+2323+greet("Hello, world! 💖");
2424+```
2525+2626+## Development
2727+2828+See [`.github/CONTRIBUTING.md`](./.github/CONTRIBUTING.md), then [`.github/DEVELOPMENT.md`](./.github/DEVELOPMENT.md).
2929+Thanks! 💖
3030+3131+<!-- You can remove this notice if you don't want it 🙂 no worries! -->
3232+3333+> 💝 This package was templated with [`create-typescript-app`](https://github.com/JoshuaKGoldberg/create-typescript-app) using the [Bingo framework](https://create.bingo).