docs: reorganize contributor setup flow and fix git branch references

- Reorganize README.md contributor setup to prioritize .env configuration
- Change all git branch references from 'main' to 'master'
- Update CONTRIBUTING.md with improved setup flow
- Fix markdown formatting issues (headers and bare URLs)
- Ensure .env.example is copied before any setup commands

Author: vikashkrdeveloper

CONTRIBUTING.md

@@ -27,26 +27,40 @@ We use GitHub to host code, to track issues and feature requests, as well as acc
    ```bash
    git clone https://github.com/YOUR_USERNAME/SafeExec.git
    cd SafeExec
+
+   # Add upstream remote for syncing
+   git remote add upstream https://github.com/vikashkrdeveloper/SafeExec.git
    ```
 
-2. **Install dependencies**
+2. **Environment Setup (REQUIRED FIRST STEP)**
 
    ```bash
-   yarn install
+   # Copy environment template - MUST DO THIS FIRST
+   cp .env.example .env
+
+   # Edit the .env file with your local configuration
+   nano .env  # or use your preferred editor
    ```
 
-3. **Set up environment**
+3. **Quick Development Setup**
 
    ```bash
-   # Quick setup for development
-   ./scripts/setup.sh --env development --seed
+   # Complete development setup in one command
+   yarn setup:dev
 
-   # Or manually:
-   cp config/environments/development.env .env
-   # Edit .env if needed
+   # This will install dependencies, build executors,
+   # start Docker environment, and seed database
    ```
 
-4. **Start development environment**
+4. **Manual Setup (Alternative)**
+
+   ```bash
+   # Install dependencies and build executors
+   yarn setup
+
+   # Start development environment
+   yarn docker:setup:dev
+   ```
 
    ```bash
    # Using the unified approach
@@ -60,7 +74,7 @@ We use GitHub to host code, to track issues and feature requests, as well as acc
    ```
 
 5. **Access API Documentation**
-   - Visit http://localhost:5000/api-docs for interactive API docs
+   - Visit <http://localhost:5000/api-docs> for interactive API docs
 
 ## Environment Management
 
@@ -91,7 +105,7 @@ ENV=production yarn docker:prod:logs # View logs
 
 ## Pull Requests
 
-1. Fork the repository and create your branch from `main`.
+1. Fork the repository and create your branch from `master`.
 2. If you've added code that should be tested, add tests.
 3. If you've changed APIs, update the Swagger documentation.
 4. Ensure the test suite passes.
@@ -128,7 +142,7 @@ yarn format        # Format code with Prettier
 yarn typecheck     # TypeScript type checking
 ```
 
-## Testing
+## Testing Guidelines
 
 ### Running Tests
 

README.md

@@ -46,32 +46,10 @@ cd SafeExec
 git remote add upstream https://github.com/vikashkrdeveloper/SafeExec.git
 ```
 
-### 2. Quick Setup (Recommended for Contributors)
+### 2. Environment Setup (REQUIRED FIRST STEP)
 
 ```bash
-# Complete development setup in one command
-yarn setup:dev
-
-# This command will:
-# - Install all dependencies
-# - Build Docker executor containers
-# - Start development environment with Docker
-# - Seed database with sample data
-```
-
-### 3. Manual Setup (Step by Step)
-
-**3.1. Install Dependencies & Build Executors**
-
-```bash
-yarn setup
-# Equivalent to: yarn install && yarn build:executors
-```
-
-**3.2. Environment Configuration**
-
-```bash
-# Copy environment template
+# Copy environment template - MUST DO THIS FIRST
 cp .env.example .env
 
 # Edit the .env file with your local configuration
@@ -90,7 +68,29 @@ JWT_SECRET=your-super-secret-jwt-key-for-development
 JWT_EXPIRES_IN=24h
 ```
 
-**3.3. Start Development Environment**
+### 3. Quick Setup (Recommended for Contributors)
+
+```bash
+# Complete development setup in one command
+yarn setup:dev
+
+# This command will:
+# - Install all dependencies
+# - Build Docker executor containers
+# - Start development environment with Docker
+# - Seed database with sample data
+```
+
+### 4. Manual Setup (Step by Step)
+
+#### 4.1. Install Dependencies & Build Executors
+
+```bash
+yarn setup
+# Equivalent to: yarn install && yarn build:executors
+```
+
+#### 4.2. Start Development Environment
 
 ```bash
 # Start all services: API, MongoDB, Redis, Nginx
@@ -104,7 +104,7 @@ yarn docker:seed:dev     # Seed database with sample data
 yarn dev                 # API only (requires local MongoDB/Redis)
 ```
 
-**3.4. Verify Setup**
+#### 4.3. Verify Setup
 
 ```bash
 # Check all services are running
@@ -131,9 +131,9 @@ yarn shell
 
 ```bash
 # 1. Sync with upstream
-git checkout main
-git pull upstream main
-git push origin main
+git checkout master
+git pull upstream master
+git push origin master
 
 # 2. Create feature branch
 git checkout -b feature/your-feature-name
@@ -233,7 +233,7 @@ See the [Contributing Guide](CONTRIBUTING.md) for more details.
 
 ---
 
-**Thank you for contributing to SafeExec! 🚀**
+## Thank you for contributing to SafeExec! 🚀
 
 Your contributions help create a better, more secure code execution platform for developers worldwide.