From 3ef21e36ae86b30409bfe544a48bbf5f23a50a5a Mon Sep 17 00:00:00 2001 From: Radiks Alijevs Date: Mon, 27 Apr 2026 15:03:45 +0300 Subject: [PATCH 1/2] chore(oss): add community templates and ignore local artifacts Made-with: Cursor --- .github/ISSUE_TEMPLATE/bug_report.yml | 59 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/feature_request.yml | 39 ++++++++++++++ .github/pull_request_template.md | 19 +++++++ .gitignore | 9 ++++ README.md | 1 + SUPPORT.md | 22 ++++++++ 7 files changed, 154 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/pull_request_template.md create mode 100644 SUPPORT.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..0522627 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..a87aa94 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..3d67e90 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..61bc0a1 --- /dev/null +++ b/.github/pull_request_template.md @@ -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 diff --git a/.gitignore b/.gitignore index 621d577..7c32cab 100644 --- a/.gitignore +++ b/.gitignore @@ -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* diff --git a/README.md b/README.md index 3c63d83..767e8b8 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 0000000..a606bb1 --- /dev/null +++ b/SUPPORT.md @@ -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. From 2514e899a655cef32109dcc9f0c7c642eba3a71b Mon Sep 17 00:00:00 2001 From: Radiks Alijevs Date: Mon, 27 Apr 2026 15:11:26 +0300 Subject: [PATCH 2/2] docs(readme): replace em dash with hyphen Made-with: Cursor --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 767e8b8..a0e2e26 100644 --- a/README.md +++ b/README.md @@ -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)