Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Vidit-Kushwaha authored Jun 17, 2024
1 parent 9fab448 commit b040261
Showing 1 changed file with 62 additions and 0 deletions.
62 changes: 62 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@

# 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](#code-of-conduct)
- [Contributing Guidelines](#contributing-guidelines)
- [Reporting Issues](#reporting-issues)
- [Getting Help](#getting-help)
- [Getting Started](#getting-started)
- [License](#license)

## Code of Conduct

We expect all contributors to adhere to the [Code of Conduct](https://github.com/Vidit-Kushwaha/react-popupify/blob/main/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](https://github.com/Vidit-Kushwaha/react-popupify/issues).
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:
```sh
git clone https://github.com/Vidit-Kushwaha/react-popupify.git
cd react-popupify

git checkout -b my-branch
```

2. Install the dependencies:
```sh
npm install
```

## License

By contributing, you agree that your contributions will be licensed under its [MIT License](https://github.com/Vidit-Kushwaha/react-popupify/blob/main/LICENSE).

0 comments on commit b040261

Please sign in to comment.