-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
26 changed files
with
1,932 additions
and
269 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, sex characteristics, gender identity and expression, | ||
level of experience, education, socio-economic status, nationality, personal | ||
appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
- Using welcoming and inclusive language | ||
- Being respectful of differing viewpoints and experiences | ||
- Gracefully accepting constructive criticism | ||
- Focusing on what is best for the community | ||
- Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
- The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
- Trolling, insulting/derogatory comments, and personal or political attacks | ||
- Public or private harassment | ||
- Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
- Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers 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, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at [email protected]. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
||
For answers to common questions about this code of conduct, see | ||
https://www.contributor-covenant.org/faq |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
name: 🐛 Bug report | ||
description: Report a reproducible bug or regression in this library. | ||
labels: [bug] | ||
assignees: | ||
- zoontek | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
# Bug report | ||
👋 Hi! | ||
**🚨 Please read the following carefully before opening a new issue 🚨** | ||
*(Your issue may be closed if it doesn't provide the required pieces of information)* | ||
Before submitting a new issue, please: | ||
- Test using the latest release of the library, as maybe your bug has been already fixed. | ||
- Check for possible duplicate issues, with possible answers. | ||
Is this still needed? Fill the form 👇 | ||
- type: textarea | ||
id: summary | ||
attributes: | ||
label: Bug summary | ||
description: | | ||
Provide a clear and concise description of what the bug is. | ||
If needed, you can also provide other samples: error messages / stack traces, screenshots, videos, etc. | ||
validations: | ||
required: true | ||
- type: input | ||
id: library-version | ||
attributes: | ||
label: Library version | ||
description: What version of the library are you using? | ||
placeholder: "x.x.x" | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: browser-info | ||
attributes: | ||
label: Environment info | ||
description: Go to [WhatIsMyBrowser](https://www.whatismybrowser.com) and copy / paste your browser & OS names + versions. | ||
render: shell | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: steps-to-reproduce | ||
attributes: | ||
label: Steps to reproduce | ||
description: | | ||
- You must provide a clear list of steps and code to reproduce the problem. | ||
- Keep the code reproducing the bug as simple as possible, with the minimum amount of code required to reproduce the issue. See https://stackoverflow.com/help/mcve. | ||
- Either re-create the bug using the repository's example app or link to a GitHub repository with code that reproduces the bug. | ||
- Explain the steps we need to take to reproduce the issue: | ||
value: | | ||
1. … | ||
2. … | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: reproducible-sample-code | ||
attributes: | ||
label: Reproducible sample code | ||
description: Please add minimal runnable repro as explained above so that the bug can be tested in isolation. | ||
render: ts | ||
validations: | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
name: 💡 Feature request | ||
description: Submit your idea for a change in the codebase. | ||
labels: [feature request] | ||
assignees: | ||
- zoontek | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
# Feature request | ||
This issue should serve for you to present or pitch an idea to the maintainers - but remember that it would be better if you were to submit a PR instead 🤗 | ||
- type: textarea | ||
id: why-is-this-needed | ||
attributes: | ||
label: Why it is needed? | ||
description: Please tell us a bit more of why you want this feature to be added, what's its origin. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: possible-implementation | ||
attributes: | ||
label: Possible implementation | ||
description: It really helps if you could describe from a technical POV how this new feature would work, which code it rely on, etc. | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: code-sample | ||
attributes: | ||
label: Code sample | ||
description: Please show how the new code could work, if doable. | ||
render: ts | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
<!-- Thanks for submitting a pull request! We appreciate you spending the time to work on these changes. Please follow the template so that the reviewers can easily understand what the code changes affect --> | ||
|
||
# Summary | ||
|
||
<!-- | ||
Explain the **motivation** for making this change: here are some points to help you: | ||
* What issues does the pull request solve? Please tag them so that they will get automatically closed once the PR is merged | ||
* What is the feature? (if applicable) | ||
* How did you implement the solution? | ||
* What areas of the library does it impact? | ||
--> | ||
|
||
## Test Plan | ||
|
||
<!-- Demonstrate the code is solid. --> | ||
|
||
### What's required for testing (prerequisites)? | ||
|
||
### What are the steps to reproduce (after prerequisites)? | ||
|
||
## Checklist | ||
|
||
<!-- Check completed item, when applicable, via: [X] --> | ||
|
||
- [ ] I added the documentation in `README.md` | ||
- [ ] I wrote / updated some tests (`__tests__/`) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Number of days of inactivity before an Issue or Pull Request becomes stale | ||
daysUntilStale: 60 | ||
# Number of days of inactivity before an Issue or Pull Request with the stale label is closed. | ||
daysUntilClose: 7 | ||
# Issues or Pull Requests. | ||
exemptLabels: | ||
- pinned | ||
- security | ||
- discussion | ||
# Set to true to ignore issues in a project (defaults to false) | ||
exemptProjects: false | ||
# Set to true to ignore issues in a milestone (defaults to false) | ||
exemptMilestones: false | ||
# Set to true to ignore issues with an assignee (defaults to false) | ||
exemptAssignees: false | ||
# Label to use when marking as stale | ||
staleLabel: stale | ||
# Comment to post when marking as stale. Set to `false` to disable | ||
markComment: > | ||
This issue has been automatically marked as stale because it has not had | ||
recent activity. It will be closed if no further activity occurs. Thank you | ||
for your contributions. You may also mark this issue as a "discussion" and I | ||
will leave this open. | ||
# Comment to post when closing a stale Issue or Pull Request. | ||
closeComment: > | ||
Closing this issue after a prolonged period of inactivity. Fell free to reopen | ||
this issue, if this still affecting you. | ||
# Limit the number of actions per hour, from 1-30. Default is 30 | ||
limitPerRun: | ||
30 | ||
# Limit to only `issues` or `pulls` | ||
only: issues |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
name: Build | ||
|
||
on: | ||
push: | ||
branches: [main] | ||
pull_request: | ||
branches: [main] | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
timeout-minutes: 60 | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- uses: pnpm/action-setup@v4 | ||
|
||
- uses: actions/setup-node@v4 | ||
with: | ||
node-version: lts/* | ||
|
||
- name: Install dependencies | ||
run: pnpm install --frozen-lockfile | ||
|
||
- name: Typecheck | ||
run: pnpm typecheck | ||
|
||
- name: Run tests | ||
run: pnpm test:ci | ||
|
||
- name: Build | ||
run: pnpm build |
Oops, something went wrong.