docs: add CONTRIBUTING.md with setup guide for Windows and Linux#173
docs: add CONTRIBUTING.md with setup guide for Windows and Linux#173xu826Jamin wants to merge 1 commit intoc2siorg:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new CONTRIBUTING.md to guide first-time contributors through prerequisites, local setup (Docker/manual), and the PR workflow for GDB-UI.
Changes:
- Introduces a contributor guide covering prerequisites, cloning, and running backend/frontend locally.
- Documents Docker-based setup plus Windows-focused manual setup notes.
- Adds guidance on finding issues, submitting PRs, and basic code style/commit conventions.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| \# Contributing to GDB-UI | ||
|
|
||
|
|
||
|
|
||
| Thank you for your interest in contributing to GDB-UI! This guide will help you | ||
|
|
||
| get the project running locally and walk you through submitting your first pull request. | ||
|
|
||
|
|
||
|
|
||
| \--- | ||
|
|
||
|
|
||
|
|
||
| \## Table of Contents | ||
|
|
There was a problem hiding this comment.
Most Markdown syntax is currently escaped (e.g., \#, \##, \---, \-, \[...\], \*\*...\*\*), so headings/lists/bold/links won’t render on GitHub. Remove the leading backslashes so these lines are interpreted as Markdown rather than literal characters.
| \- \[Prerequisites](#prerequisites) | ||
|
|
||
| \- \[Forking and Cloning](#forking-and-cloning) | ||
|
|
||
| \- \[Running the Project Locally](#running-the-project-locally) | ||
|
|
||
|   - \[Option A: Docker](#option-a-docker) | ||
|
|
||
|   - \[Option B: Manual Setup](#option-b-manual-setup) |
There was a problem hiding this comment.
The Table of Contents includes literal HTML entities ( ) and escaped list markers (\-), which prevents proper nested list formatting. Replace the entities with normal spaces and remove the escaping so GitHub renders the TOC as a list.
| 1\. Go to \[github.com/c2siorg/GDB-UI](https://github.com/c2siorg/GDB-UI) | ||
|
|
||
| 2\. Click \*\*Fork\*\* (top right) to create your own copy | ||
|
|
||
| 3\. Clone your fork locally: |
There was a problem hiding this comment.
Ordered list markers are escaped as 1\. / 2\. / etc, which stops GitHub from recognizing them as lists. Use normal 1. / 2. syntax so the steps render correctly.
|
|
||
| ```bash | ||
|
|
||
| git clone https://github.com/YOUR\_USERNAME/GDB-UI.git |
There was a problem hiding this comment.
Inside fenced code blocks the backslash escapes are rendered literally. For example, YOUR\_USERNAME will be copied as-is and will fail for users; it should be YOUR_USERNAME (same applies to other escaped underscores and \# comment lines within code fences).
| git clone https://github.com/YOUR\_USERNAME/GDB-UI.git | |
| git clone https://github.com/YOUR_USERNAME/GDB-UI.git |
| \# Windows: | ||
|
|
||
| venv\\Scripts\\activate | ||
|
|
||
| \# Mac/Linux: | ||
|
|
||
| source venv/bin/activate | ||
|
|
There was a problem hiding this comment.
The Windows venv activation command shown (venv\\Scripts\\activate) is shell-specific and won’t work in PowerShell (common default on Windows). Consider documenting both cmd.exe and PowerShell activation commands (or explicitly state which shell the instructions target) to avoid setup dead-ends.
|
|
||
|   - What changes did you make? | ||
|
|
||
|   - Reference the issue with `Fixes #ISSUE\_NUMBER` |
There was a problem hiding this comment.
This inline code is also affected by escaped underscores: Fixes #ISSUE\_NUMBER will be shown/copied with the backslash. Use Fixes #ISSUE_NUMBER so contributors can copy/paste it directly.
|   - Reference the issue with `Fixes #ISSUE\_NUMBER` | |
|   - Reference the issue with `Fixes #ISSUE_NUMBER` |
Summary
Adds a CONTRIBUTING.md file to help new contributors get started with GDB-UI.
What's included
Fixes #43