Skip to content

Commit c79b620

Browse files
authored
feat(docs): enhance docs with GitHub flavors markdown
Signed-off-by: Son Nguyen <[email protected]>
1 parent 9920c9e commit c79b620

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing to FastFetch
2+
3+
Thanks for your interest in contributing! Please take a moment to read this guide.
4+
5+
## Getting Started
6+
7+
1. Fork the repository and clone your fork (adjust the URL to your fork as needed):
8+
9+
```bash
10+
git clone <[email protected]:your-username/FastFetch.git>
11+
cd FastFetch
12+
```
13+
14+
2. Install dependencies:
15+
16+
```bash
17+
npm ci
18+
```
19+
20+
3. Create a new branch from `develop`:
21+
22+
```bash
23+
git checkout develop
24+
git checkout -b feat/my-improvement
25+
```
26+
27+
## Workflow
28+
29+
- **Code style**: We use ESLint + Prettier. Your editor should auto-format on save.
30+
- **Testing**: Add/update Jest tests under `__tests__/`.
31+
- **Commit messages**: Use [Conventional Commits](https://www.conventionalcommits.org).
32+
33+
```bash
34+
feat: add profile header sticky behavior
35+
fix: prevent overflow on long words
36+
docs: update onboarding README
37+
```
38+
39+
## Pull Requests
40+
41+
1. Push your branch to your fork:
42+
43+
```bash
44+
git push -u origin feat/my-improvement
45+
```
46+
47+
2. Open a PR against `develop` and fill out the PR template.
48+
3. Ensure CI passes (lint, tests, build).
49+
4. Respond to review feedback—thank you!

0 commit comments

Comments
 (0)