Thank you for your contribution 🤝
- Before opening a new issue, first search for existing issues to avoid duplications.
- Open a bug report with detailed description to make things easier.
- You can help by fixing existing issues
- Don't work on issues assigned to others (to avoid duplicate efforts)
- Before starting to work on an issue, please first add a comment and ask to get assigned to that issue. This way everyone will know you're working on that and it avoids duplicate efforts.
- Commit messages must start with:
fix: #<issue number> <description>
, so the issue will close automatically and it gets added to changelog file on a release.
- For feature requests, open a new issue
- All feature requests may not fit this library and some may get rejected. Don't take it personally.
- A pull request must fix an open issue assigned to you. If there's no issue, please create one first. If it's not assigned to you, please ask for it in the comments. This is for avoiding duplicate efforts.
- Fixing typos doesn't need to be an issue. You can just open a pull request.
-
Fork and clone the repo on local, if you are using GitHub CLI just run:
gh repo fork malkiii/react-pre-hooks --clone
-
Install package dependencies and build the package:
pnpm install && pnpm build
-
start the development server:
pnpm docs:dev
-
to generate the hook pages (this process will be done automatically with
docs:dev
):pnpm build && pnpm generate:pages
Before you add a new hook, please open a request.
- Add the hook folder to
packages/hooks/src
folder. - Create an
index.ts
file that includes the code. - Create an
index.page.tsx
file that includes the page content (see this example).
-
the folder structure should look like this:
packages ├── hooks │ ├── src │ │ ├── useHook │ │ │ ├── index.ts │ │ │ ├── index.page.tsx