The following is a set of guidelines for contributing to ahooks. Please spend several minutes reading these guidelines before you create an issue or pull request.
All work on ahooks happens directly on GitHub. Both core team members and external contributors send pull requests which go through the same review process.
If you want to add a new Hook，we recommend that you first create an issue that describes the application scenario and usage of the Hook, see [RFC] useLockFn。
Then you can initialize a new Hook based on an existing Hook.
We are monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation.
Before submitting a pull request, please make sure the following is done:
-
create your branch from the master.
-
If you've fixed a bug or added code that should be tested, add tests!
-
Ensure the test suite passes
yarn run test。
After cloning ahooks, run yarn run init to fetch its dependencies. Then, you can run several commands:
-
yarn startrunsahookswebsite locally。 -
yarn run testruns the complete test suite。 -
yarn run buildto build。