Skip to content

Commit d2a86df

Browse files
authored
Update repository URLs in CONTRIBUTING.md
1 parent 3300443 commit d2a86df

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing to GEMC
2+
3+
We welcome contributions of code, documentation, tests, examples, and bug reports. This guide explains how to propose changes via GitHub.
4+
5+
> **Quickstart**
6+
> 1. Open an issue to discuss your idea or bug.
7+
> 2. Fork the repo and clone your fork.
8+
> 3. Create a feature branch.
9+
> 4. Commit changes with clear messages and add tests/docs.
10+
> 5. Keep your fork in sync with `upstream`.
11+
> 6. Open a pull request (PR) from your branch.
12+
13+
---
14+
15+
## 1) Before you start: open an issue
16+
Have a feature in mind? Open an issue describing the problem, proposed solution, and any alternatives. For obvious, small bug fixes, opening a PR directly is fine—but filing an issue first is still appreciated.
17+
18+
If you’re not sure where to help, ask in an issue—documentation improvements are always welcome.
19+
20+
## 2) Fork and clone
21+
22+
Create your fork on GitHub, then:
23+
24+
```bash
25+
git clone https://github.com/<your-username>/src.git gemc
26+
cd gemc
27+
git remote add upstream https://github.com/gemc/src.git
28+
git remote -v

0 commit comments

Comments
 (0)