Skip to content

Commit 6bf88fa

Browse files
committed
docs: add contributing template
1 parent 4c9c268 commit 6bf88fa

1 file changed

Lines changed: 74 additions & 0 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributing
2+
3+
## Request for changes/ Pull Requests
4+
5+
You first need to create a fork of the [crypto-driver](https://github.com/vgbr-dev/crypto-driver/) repository to commit your changes to it. Methods to fork a repository can be found in the [GitHub Documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
6+
7+
Then add your fork as a local project:
8+
9+
```sh
10+
# Using HTTPS
11+
git clone https://github.com/vgbr-dev/crypto-driver.git
12+
13+
# Using SSH
14+
git clone git@github.com:vgbr-dev/crypto-driver.git
15+
```
16+
17+
> [Which remote URL should be used ?](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories)
18+
19+
Then, go to your local folder
20+
21+
```sh
22+
cd crypto-driver
23+
```
24+
25+
Add git remote controls :
26+
27+
```sh
28+
# Using HTTPS
29+
git remote add fork https://github.com/YOUR-USERNAME/crypto-driver.git
30+
git remote add upstream https://github.com/vgbr-dev/crypto-driver.git
31+
32+
33+
# Using SSH
34+
git remote add fork git@github.com:YOUR-USERNAME/crypto-driver.git
35+
git remote add upstream git@github.com/vgbr-dev/crypto-driver.git
36+
```
37+
38+
You can now verify that you have your two git remotes:
39+
40+
```sh
41+
git remote -v
42+
```
43+
44+
## Receive remote updates
45+
46+
In view of staying up to date with the central repository :
47+
48+
```sh
49+
git pull upstream main
50+
```
51+
52+
## Choose a base branch
53+
54+
Before starting development, you need to know which branch to base your modifications/additions on. When in doubt, use main.
55+
56+
| Type of change | Branches |
57+
|:------------------|----------------------:|
58+
| Documentation | `main` |
59+
| Bug fixes | `main` |
60+
| New features | `main` |
61+
| New issues models | `YOUR-USERNAME:patch` |
62+
63+
```sh
64+
# Switch to the desired branch
65+
git switch main
66+
67+
# Pull down any upstream changes
68+
git pull
69+
70+
# Create a new branch to work on
71+
git switch --create patch/1234-name-issue
72+
```
73+
74+
Commit your changes, then push the branch to your fork with `git push -u fork` and open a pull request on [the crypto-driver repository](https://github.com/vgbr-dev/crypto-driver/) following the template provided.

0 commit comments

Comments
 (0)