-
Notifications
You must be signed in to change notification settings - Fork 280
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
23e30f3
commit 5545190
Showing
1 changed file
with
97 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
# Contributing to Review App | ||
|
||
Thank you for your interest in contributing to Review App! We welcome contributions from the community to help improve and enhance the project. Please take a moment to read through the following guidelines to get started. | ||
|
||
## Table of Contents | ||
- [Getting Started](#getting-started) | ||
- [Contributing Guidelines](#contributing-guidelines) | ||
- [Setting Up the Development Environment](#setting-up-the-development-environment) | ||
- [Submitting a Pull Request (PR)](#submitting-a-pull-request-pr) | ||
- [Code of Conduct](#code-of-conduct) | ||
|
||
## Getting Started | ||
|
||
Before you start contributing, make sure you have: | ||
|
||
- A GitHub account. | ||
- Git installed on your local machine. | ||
- Node.js and npm (Node Package Manager) installed on your local machine. | ||
|
||
## Contributing Guidelines | ||
|
||
We follow these guidelines for contributing: | ||
|
||
1. Fork the repository to your GitHub account. | ||
2. Clone your forked repository to your local machine: | ||
|
||
```bash | ||
git clone https://github.com/yourusername/review-app.git | ||
``` | ||
|
||
3. Create a new branch for your contribution: | ||
|
||
```bash | ||
git checkout -b feature-name | ||
``` | ||
|
||
4. Make your changes and ensure your code follows our coding standards and practices. | ||
|
||
5. Test your changes locally to ensure they work as expected. | ||
|
||
6. Commit your changes with clear and concise commit messages: | ||
|
||
```bash | ||
git commit -m "Add feature: your feature description" | ||
``` | ||
|
||
7. Push your changes to your GitHub fork: | ||
|
||
```bash | ||
git push origin feature-name | ||
``` | ||
|
||
8. Create a pull request (PR) to the main repository's `main` branch. | ||
|
||
## Setting Up the Development Environment | ||
|
||
To set up the development environment locally, follow these steps: | ||
|
||
1. Clone the repository: | ||
|
||
```bash | ||
git clone https://github.com/yourusername/review-app.git | ||
cd review-app | ||
``` | ||
|
||
2. Install project dependencies: | ||
|
||
```bash | ||
npm install | ||
# or | ||
yarn install | ||
# or | ||
pnpm install | ||
``` | ||
|
||
3. Start the development server: | ||
|
||
```bash | ||
npm run dev | ||
# or | ||
yarn dev | ||
# or | ||
pnpm dev | ||
``` | ||
|
||
The project will be accessible at [http://localhost:3000](http://localhost:3000). | ||
|
||
## Submitting a Pull Request (PR) | ||
|
||
When you're ready to submit your changes, create a pull request (PR) following our guidelines. Be sure to provide a clear description of your changes in the PR, and one of our maintainers will review it. | ||
|
||
## Code of Conduct | ||
|
||
Please note that we have a [Code of Conduct](CODE_OF_CONDUCT.md) that we expect all contributors to follow. Ensure you read and adhere to it throughout your contribution journey. | ||
|
||
We appreciate your contributions and look forward to collaborating with you! | ||
``` |