docs: create CONTRIBUTING.md with getting started guide
Swadhin Biswas committed 7 months ago
c9b9b99
1 parent 287eee9
commit c9b9b99
1 file changed
+50 -0
Showing 1 changed file+50-0
▼CONTRIBUTING.md
+50-0
| @@ -0,0 +1,50 @@ | ||
1 | +# Contributing to FetchX | |
2 | + | |
3 | +First off, thank you for considering contributing to FetchX! Every contribution matters — whether it's a bug report, a new distro logo, a feature implementation, or documentation improvement. | |
4 | + | |
5 | +## Table of Contents | |
6 | + | |
7 | +- [Getting Started](#getting-started) | |
8 | +- [Development Setup](#development-setup) | |
9 | +- [Project Structure](#project-structure) | |
10 | +- [How to Contribute](#how-to-contribute) | |
11 | + - [Reporting Bugs](#reporting-bugs) | |
12 | + - [Suggesting Features](#suggesting-features) | |
13 | + - [Adding Distro Logos](#adding-distro-logos) | |
14 | + - [Code Contributions](#code-contributions) | |
15 | +- [Code Style & Guidelines](#code-style--guidelines) | |
16 | +- [Testing](#testing) | |
17 | +- [Pull Request Process](#pull-request-process) | |
18 | +- [Development Tips](#development-tips) | |
19 | + | |
20 | +--- | |
21 | + | |
22 | +## Getting Started | |
23 | + | |
24 | +### Prerequisites | |
25 | + | |
26 | +- **Rust** (2021 edition) — install via [rustup](https://rustup.rs/): | |
27 | + ```bash | |
28 | + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh | |
29 | + ``` | |
30 | +- **Git** | |
31 | +- A Linux, macOS, or BSD system for testing | |
32 | + | |
33 | +### Development Setup | |
34 | + | |
35 | +```bash | |
36 | +# 1. Fork the repo on GitHub, then clone your fork | |
37 | +git clone https://github.com/YOUR_USERNAME/fetchx.git | |
38 | +cd fetchx/fetchx | |
39 | + | |
40 | +# 2. Build in debug mode (faster compilation) | |
41 | +cargo build | |
42 | + | |
43 | +# 3. Run tests | |
44 | +cargo test | |
45 | + | |
46 | +# 4. Run fetchx locally | |
47 | +cargo run | |
48 | + | |
49 | +# 5. Build optimized release | |
50 | +cargo build --release | |
0 | 51 | |