CONTRIBUTING.md

Contributing to react-customs ✨

Hello there! We're excited that you're interested in contributing to react-customs.

Important: Please use JavaScript only for all contributions until we transition to TypeScript.

Table of Contents

• Contribution Types
  • 1. Developing a New Hook
  • 2. Modifying an Existing Hook
  • 3. Fixing Typos
• Pull Request Process

Contribution Types

There are several ways you can contribute:

1. Developing a New Hook

• Check the issues tab for existing proposals for new hooks.
  • If an issue exists, assign it to yourself and comment to inform others that you are working on it.
  • If no issue exists, create a new issue proposing the new hook.
• Create a new branch for your work.
• Develop the new hook following the pattern of existing hooks.
• Create documentation in the docs folder, following the structure of existing hook documentation.
• Provide an example of usage, using external links for demos.
  • Note: Use a local version of the hook for your demo initially. After your pull request is merged, update your demo to use the npm version.

2. Modifying an Existing Hook

• This includes bug fixes or adding new features to an existing hook.
• Check the issues tab for related discussions or create a new issue.
• Create a new branch for your work.
• Update examples and documentation if necessary.

3. Fixing Typos

• Create a new branch for your work.
• Correct any documentation as needed.

Pull Request Process

1. Fork the repository.

2. Clone your fork locally.

git clone https://github.com/your-username/react-customs.git

cd react-customs

3. Install dependencies.

npm install

4. Create and check out a new branch for your contribution.

git checkout -b your-branch-name

5. Make your changes.

6. Push to your fork.

git add .
git commit -m "Description of your changes"
git push origin your-branch-name

7. Submit a pull request to the original repository.

Thank you for contributing to react-customs! Your efforts help make this project better for everyone.