Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

54 lines (37 loc) · 1.94 KB
Raw

Contributing

Thanks for being willing to contribute 🙌 If you contribute to this project, you agree to release your work under the license of this project.

Working on your first Pull Request? You can learn how from this First Contributions guide.

Project setup

  1. Fork and clone the repo
  2. Run pnpm install to install dependencies
  3. Create a branch for your PR with git checkout -b pr/your-branch-name

Tip: Keep your main branch pointing at the original repository and make pull requests from branches on your fork. To do this, run:

git remote add upstream https://github.com/childrentime/reactuse.git
git fetch upstream
git branch --set-upstream-to=upstream/master master

This will add the original repository as a "remote" called "upstream," Then fetch the git information from that remote, then set your local master branch to use the upstream master branch whenever you run git pull. Then you can make all of your pull request branches based on this master branch. Whenever you want to update your version of master, do a regular git pull.

Development

This library is a collection of React hooks so a proposal for a new hook will need to utilize the React Hooks API internally to be taken into consideration.

Project Structure

packages is divided into two parts.

packages
core/ - the core hook package
website-docusaurus/ - the document package

Creating a new hook

Before you start working, it's better to open an issue to discuss first.

You can write your tests first if you prefer test-driven development.

Updating an existing hook

Feel free to enhance the existing functions. Please try not to introduce breaking changes.

Thanks

Thank you again for being interested in this project! You are awesome!