Add CONTRIBUTING.md, move setup instructions from README

Author: jai-deepsource

CONTRIBUTING.md

@@ -0,0 +1,78 @@
+# Contributing to Good First Issue
+
+Thanks for your interest in contributing! This guide will help you get started.
+
+## Prerequisites
+
+Before you begin, make sure you have the following installed:
+
+- **Node.js** (v18 or later) - [Download](https://nodejs.org/)
+- **Python 3** - [Download](https://www.python.org/downloads/)
+- **Bun** - A fast JavaScript runtime and package manager. Install it with:
+  ```bash
+  curl -fsSL https://bun.sh/install | bash
+  ```
+  Or see [bun.sh](https://bun.sh/) for other installation methods.
+
+## Project Structure
+
+Good First Issue has two main components:
+
+- **Front-end app** - Built with Nuxt.js, displays the curated list of repositories
+- **Data population script** - Written in Python, fetches repository data from GitHub
+
+## Setting Up Locally
+
+1. **Clone the repository**
+
+   ```bash
+   git clone https://github.com/DeepSourceCorp/good-first-issue.git
+   cd good-first-issue
+   ```
+
+2. **Set up sample data files**
+
+   The front-end app needs data files to display repositories. Copy the sample files to get started:
+
+   ```bash
+   cp data/generated.sample.json data/generated.json
+   cp data/tags.sample.json data/tags.json
+   ```
+
+   These files contain:
+   - `generated.json` - Repository metadata (stars, issues, languages, etc.)
+   - `tags.json` - Language tags for filtering
+
+3. **Install dependencies**
+
+   ```bash
+   bun install
+   ```
+
+4. **Start the development server**
+
+   ```bash
+   bun dev
+   ```
+
+   The app will open at [http://localhost:3000](http://localhost:3000).
+
+## Running Tests
+
+To run the data sanity tests:
+
+```bash
+python -m pytest gfi/test_data.py
+```
+
+Or using unittest directly:
+
+```bash
+python gfi/test_data.py
+```
+
+## Making Changes
+
+1. Create a new branch for your changes
+2. Make your changes and test them locally
+3. Submit a pull request with a clear description of what you changed and why

README.md

@@ -30,26 +30,6 @@ To maintain the quality of projects in Good First Issue, please make sure your G
 
 Once your submission is reviewed and approved, it will be added to [goodfirstissue.dev](https://goodfirstissue.dev/).
 
-## Setting up the project locally
+## Contributing
 
-Good First Issue has two components — the front-end app built with Nuxt.js and a data population script written in Python.
-
-To contribute new features and changes to the website, you would want to run the app locally. Please follow these steps:
-
-1. Clone the project locally. Make sure you have Python 3 and a recent version of Node.js installed on your computer.
-
-2. Make a copy of the sample data files for your local app to use and rename them to the filename that the app expects. **This step is important, as the front-end app won't work without these data files.**
-
-```bash
-$ cp data/generated.sample.json data/generated.json
-$ cp data/tags.sample.json data/tags.json
-```
-
-3. Build the front-end app and start the development server.
-
-```bash
-$ bun install # install the dependencies
-$ bun dev # start the development server
-```
-
-The app should open in your browser.
+Want to contribute? See [CONTRIBUTING.md](CONTRIBUTING.md) for setup instructions and guidelines.