Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

62 lines (41 loc) · 2.17 KB
Raw

Contribution Guide

Thank you for considering contributing to React-Popupify! We appreciate your efforts in helping us improve and maintain this project.

This guide provides instructions and guidelines to help you get started.

Table of Contents

Code of Conduct

We expect all contributors to adhere to the Code of Conduct. Please read it to understand the standards of behavior we expect from everyone participating in this project.

Contributing Guidelines

  • Code Style: Ensure your code follows the project's coding style. We use Prettier for code formatting.
  • Commits: Write clear and concise commit messages. Follow the Conventional Commits specification.
  • Tests: Add and update tests as necessary. Ensure all tests pass before submitting a pull request.
  • Documentation: Update the documentation to reflect your changes, including comments in the code, README, and other relevant files.
  • Review: Be prepared to address feedback and make necessary changes.

Reporting Issues

If you encounter any issues or have suggestions for improvements, please open an issue. Provide as much detail as possible to help us understand and address the problem.

Getting Help

If you need help or have any questions, feel free to reach out by opening an issue or joining our community discussions.

Getting Started

Pre-requisites

  • Node: ^16.0.0

Installation

Clone the repository and create a local branch:

  1. Clone the repository:
git clone https://github.com/Vidit-Kushwaha/react-popupify.git
cd react-popupify
    
git checkout -b my-branch
  1. Install the dependencies:
npm install

License

By contributing, you agree that your contributions will be licensed under its MIT License.