From ef99ec727471cd831405c4c36f9dffa33e179869 Mon Sep 17 00:00:00 2001 From: Nancy Verma Date: Fri, 26 Jun 2026 14:28:23 +0530 Subject: [PATCH] Create get-started-with-recode.md --- docs/get-started-with-recode.md | 48 +++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 docs/get-started-with-recode.md diff --git a/docs/get-started-with-recode.md b/docs/get-started-with-recode.md new file mode 100644 index 00000000..2154514d --- /dev/null +++ b/docs/get-started-with-recode.md @@ -0,0 +1,48 @@ +# Get Started with Recode + +Welcome to Recode! Thank you for wanting to contribute. This guide will help you set up the project locally on your machine and submit your first contribution. + +## Prerequisites + +Before you begin, ensure you have the following installed: +- [Git](https://git-scm.com) +- [Node.js](https://nodejs.org) (v18 or higher recommended) +- A package manager like npm, yarn, or pnpm + +## Local Setup Instructions + +### 1. Fork the Repository +Click the **Fork** button at the top right of this repository page to create a copy of the project under your own GitHub account. + +### 2. Clone Your Fork +Clone your cloned repository to your local machine: +```bash +git clone https://github.com/recode-web.git +cd recode-web +``` + +### 3. Add Upstream Remote +Keep your fork synced with the main repository by adding it as an upstream remote: +```bash +git remote add upstream https://github.comsanjay-kv/recode-web.git +``` + +### 4. Install Dependencies +Install the required project dependencies using your package manager: +```bash +npm install +``` + +### 5. Run the Project Locally +Start the local development server to test your changes: +```bash +npm run dev +``` +Open `http://localhost:3000` in your browser to view the application. + +## Contribution Workflow + +1. **Always get assigned first**: Do not open a PR unless a maintainer explicitly assigns the issue to you. +2. **Create a branch**: Use descriptive names like `feat/feature-name` or `fix/bug-name`. +3. **Commit your changes**: Write clear, concise commit messages. +4. **Push and Open a PR**: Push your branch to your fork and submit a Pull Request against the main project's `main` branch.