Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (47 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

73 lines (47 loc) · 1.59 KB

Contribution Guidelines

Thank you for your interest in contributing to React Google Reviews!

We appreciate all contributions, whether it's fixing a bug, adding a feature, improving documentation, or optimizing performance. This guide will help you get started.

Project Setup

1. Fork & Clone

First, fork the repository and clone it locally:

git clone https://github.com/Featurable/react-google-reviews.git
cd react-google-reviews

2. Install Dependencies

Ensure you have Node.js (LTS recommended) and install dependencies:

npm install

3. Start Development Environment

Start the development environment by running:

npm run dev

How to Contribute

1. Find an Issue

  • Check GitHub Issues
  • If you have an idea, create a new issue before submitting a PR.

2. Create a New Branch

Follow branch naming conventions:

git checkout -b feature/my-new-component  # For new features
git checkout -b fix/button-padding  # For bug fixes

3. Write Code & Tests

  • Follow our coding style (Prettier).
  • If applicable, update documentation (README.md).

4. Commit & Push

Commit messages should be descriptive:

git commit -m "fix(button): resolve padding issue"
git push origin feature/my-new-component

5. Submit a PR

  • Open a Pull Request against the main branch.
  • Reference the issue it fixes (if applicable).
  • Request a review from a maintainer.

Community & Support

We appreciate your contributions—thank you for making React Google Reviews better!