Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CONTRIBUTING.md #26

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 0 additions & 106 deletions CONTRIBUTING.md

This file was deleted.

98 changes: 98 additions & 0 deletions feat: Update CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
# Welcome to the Exciting World of Review App Contribution!

Your enthusiasm for contributing to Review App is truly appreciated! Our community thrives on the creativity and expertise of individuals like you. Dive into this guide to make your contribution journey smooth, enjoyable, and impactful.

## Embark on the Adventure

### [Getting Started](#getting-started)

Before you kick off your journey into frontend magic, ensure you've got the essentials:

- A GitHub account, your gateway to collaboration.
- Git, your trusty companion, installed locally.
- Node.js and npm, the dynamic duo, installed on your machine.
- Yarn, your yarn of choice, woven into your local setup.

## [Contributing Guidelines](#contributing-guidelines)

Unlock the gates to contribution greatness with these guidelines:

1. **Fork the Frontend Repository:**
Fork your own copy of the frontend repository - your playground for creativity.

2. **Clone and Set Sail:**
Clone your masterpiece to your local machine and set sail into the project directory.

```bash
git clone https://github.com/yourusername/review-app.git
cd review-app
```

3. **Create a New Branch:**
Forge a new branch for your contribution, your canvas for innovation.

```bash
git checkout -b feature-name
```

4. **Code and Illuminate:**
Cast your coding spells, ensuring they align with our magical coding standards. Illuminate your changes locally to witness their brilliance.

5. **Commit with Wizardry:**
Enchant your changes with clear and concise commit messages.

```bash
git commit -m "Add feature: your feature description"
```

6. **Summon the GitHub Spirits:**
Push your magical changes to your GitHub realm.

```bash
git push origin feature-name
```

7. **Craft a Portal (Pull Request):**
Weave a portal (Pull Request) to the main repository's `main` branch.

## [Setting Up the Enchanting Development Environment](#setting-up-the-development-environment)

To conjure a local development environment:

1. **Clone the Frontend Repository:**
```bash
git clone https://github.com/yourusername/review-app.git
cd review-app
```

2. **Invoke Dependencies:**
Invoke the necessary spells to install project dependencies using Yarn.

```bash
yarn install
```

3. **Channel Your Environment Variables:**
Create a `.env.local` spell book in the project root and inscribe the required environment variables.

```
NEXT_PUBLIC_AWS_API_URL=http://localhost:8000/local
NEXT_PUBLIC_APP_DASHBOARD_DOMAIN=app
NEXT_PUBLIC_APP_DOMAIN=localhost:3000
```

4. **Summon the Development Portal:**
```bash
yarn dev
```
Open the portal at [http://localhost:3000](http://localhost:3000).

## [Submit a Mystical Pull Request (PR)](#submitting-a-pull-request-pr)

When your magical changes are ready, summon a mystical Pull Request. Share the tale of your changes in the PR, and our maintainers will be your guides through this enchanted realm.

## [Code of Wizardry](#code-of-conduct)

Observe the ancient [Code of Conduct](CODE_OF_CONDUCT.md) to ensure harmony in our mystical community.

Your contributions are like spells, shaping the magical world of Review App. We eagerly await the wonders you'll bring! 🚀
Loading