Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Bug report
description: Report a reproducible bug in @dedalik/use-react
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for reporting. Please include a minimal reproduction so we can fix faster.
- type: input
id: hook
attributes:
label: Hook or utility name
placeholder: useElementSize, useDebounce, ...
validations:
required: true
- type: input
id: package_version
attributes:
label: Package version
placeholder: 1.1.1
validations:
required: true
- type: input
id: react_version
attributes:
label: React version
placeholder: 18.3.x
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce
placeholder: |
1. ...
2. ...
3. ...
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behavior
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual behavior
validations:
required: true
- type: textarea
id: repro
attributes:
label: Reproduction link or repo
placeholder: GitHub repo / StackBlitz / CodeSandbox
validations:
required: false
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Security policy
url: https://github.com/dedalik/use-react/blob/main/SECURITY.md
about: Please report security vulnerabilities privately
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Feature request
description: Propose a new hook, utility, or API improvement
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: input
id: proposal
attributes:
label: Proposal summary
placeholder: Add useSomething(...)
validations:
required: true
- type: textarea
id: problem
attributes:
label: Problem statement
description: What problem does this solve?
validations:
required: true
- type: textarea
id: api
attributes:
label: Suggested API
placeholder: |
const value = useSomething(options)
validations:
required: false
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
validations:
required: false
- type: textarea
id: context
attributes:
label: Additional context
validations:
required: false
19 changes: 19 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## What changed

-

## Why

-

## Test plan

- [ ] `npm run format:check`
- [ ] `npm run lint`
- [ ] `npm run test`
- [ ] `npm run build`

## Notes

- Breaking changes: yes / no
- Docs updated: yes / no
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
.idea
.vscode
.cursor
.DS_Store
node_modules
dist
coverage
.env
.env.*
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Collection of React Hooks

Current exports: **188** (hooks + utilities).

Full index: **[usereact.org/functions](https://usereact.org/functions)** each hook name below links to its reference page on the docs site.
Full index: **[usereact.org/functions](https://usereact.org/functions)** - each hook name below links to its reference page on the docs site.

### [State (16)](https://usereact.org/functions/state)

Expand Down Expand Up @@ -290,6 +290,7 @@ Refer to the **[functions catalog](https://usereact.org/functions)** or the **[d
- [Contributing guide](./CONTRIBUTING.md)
- [Code of conduct](./CODE_OF_CONDUCT.md)
- [Security policy](./SECURITY.md)
- [Support](./SUPPORT.md)

## Install

Expand Down
22 changes: 22 additions & 0 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Support

Thanks for using `@dedalik/use-react`.

## Where to ask questions

- For usage questions and troubleshooting, open a GitHub Discussion (recommended).
- If Discussions are unavailable, open an Issue and use the `question` label.

## Where to report bugs

- Open a GitHub Issue with a minimal reproduction.
- Include:
- hook name and expected behavior
- actual behavior
- React version, browser/runtime, and package version
- reproduction steps (or a small repo/sandbox)

## Security issues

Do not open public issues for security vulnerabilities.
Follow `SECURITY.md` for responsible disclosure.