Skip to content

Commit a8e3be8

Browse files
author
Yurickh
committed
Fix CONTRIBUTING.md markdown
1 parent 82c54ed commit a8e3be8

File tree

1 file changed

+24
-19
lines changed

1 file changed

+24
-19
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,50 +7,55 @@
77

88
## Pull requests
99

10-
1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, and configure the remotes:
10+
#### 1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, and configure the remotes:
1111

12-
```bash
13-
# Clone your fork of the repo into the current directory
12+
a. Clone your fork of the repo into the current directory
13+
```bash
1414
git clone https://github.com/<your-username>/csscomb.js
15-
# Navigate to the newly cloned directory
15+
```
16+
17+
b. Navigate to the newly cloned directory
18+
```bash
1619
cd csscomb.js
17-
# Assign the original repo to a remote called `upstream`
20+
```
21+
22+
c. Assign the original repo to a remote called `upstream`
23+
```bash
1824
git remote add upstream https://github.com/csscomb/csscomb.js
1925
```
2026

21-
2. If you cloned a while ago, get the latest changes from upstream:
27+
#### 2. If you cloned a while ago, get the latest changes from upstream:
2228

23-
```bash
29+
```bash
2430
git checkout dev
2531
git pull upstream dev
2632
```
2733

28-
**IMPORTANT**: We are using `dev` branch for development, not `master`.
34+
> **IMPORTANT**: We are using `dev` branch for development, not `master`.
2935
30-
3. Create a topic branch for your feature, change, or fix:
36+
#### 3. Create a topic branch for your feature, change, or fix:
3137

32-
```bash
38+
```bash
3339
git checkout -b <topic-branch-name>
3440
```
3541

36-
4. Patches and features will not be accepted without tests.
37-
Run `npm test` to check that all tests pass after you've made changes.
42+
#### 4. Patches and features will not be accepted without tests.
43+
Run `npm test` to check that all tests pass after you've made changes.
3844

39-
5. Update the `README.md` or [docs](https://github.com/csscomb/csscomb.js/tree/master/doc) if there were corresponding changes or new options.
45+
#### 5. Update the `README.md` or [docs](https://github.com/csscomb/csscomb.js/tree/master/doc) if there were corresponding changes or new options.
4046

41-
6. Locally rebase the upstream development branch into your topic branch:
47+
#### 6. Locally rebase the upstream development branch into your topic branch:
4248

43-
```bash
49+
```bash
4450
git pull --rebase upstream dev
4551
```
4652

47-
7. Push your topic branch up to your fork:
48-
49-
```bash
53+
#### 7. Push your topic branch up to your fork:
54+
```bash
5055
git push origin <topic-branch-name>
5156
```
5257

53-
8. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) to a `dev` branch with a clear title and description.
58+
#### 8. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) to a `dev` branch with a clear title and description.
5459

5560
## For maintainers
5661

0 commit comments

Comments
 (0)