CONTRIBUTING.md

Contributing to react-persisted-state

You're welcome to contribute to react-persisted-state and help me improve it. Below are some guidelines to help you contribute effectively.

Getting Started

Fork and Clone the Repository

1. Fork the react-persisted-state repository to your own GitHub account.
2. Clone your fork to your local machine and navigate into it:

git clone https://github.com/YOUR_USERNAME/react-persisted-state.git
cd react-persisted-state

Set UP Your Environment

Make sure you have pnpm installed. If not, you can install with npm:

npm install -g pnpm

Then install the dependencies:

pnpm install

Making Changes

1. Create a new branch for your changes
2. Implement your changes, adhering to the existing code style.

Before Submitting

Run Tests

Ensure that your changes do not break any existing tests, and if you're adding new functionality, consider adding new tests:

pnpm test

Commit Your Changes

Commit your changes with a clear and descriptive message:

git commit -m "tag: add a brief description of the change"

Submitting Your Changes

1. Push your changes to your fork.
2. Navigate to the original react-persisted-state repository your forked; you should see a prompt to create a pull request from your new branch. Follow the GitHub instructions to submit your pull request.

After Submitting

• Wait for feedback ;)

Thank you for contributing to react-persisted-state!