|
7 | 7 |
|
8 | 8 | ## Pull requests |
9 | 9 |
|
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: |
11 | 11 |
|
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 |
14 | 14 | 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 |
16 | 19 | 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 |
18 | 24 | git remote add upstream https://github.com/csscomb/csscomb.js |
19 | 25 | ``` |
20 | 26 |
|
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: |
22 | 28 |
|
23 | | - ```bash |
| 29 | +```bash |
24 | 30 | git checkout dev |
25 | 31 | git pull upstream dev |
26 | 32 | ``` |
27 | 33 |
|
28 | | - **IMPORTANT**: We are using `dev` branch for development, not `master`. |
| 34 | +> **IMPORTANT**: We are using `dev` branch for development, not `master`. |
29 | 35 |
|
30 | | -3. Create a topic branch for your feature, change, or fix: |
| 36 | +#### 3. Create a topic branch for your feature, change, or fix: |
31 | 37 |
|
32 | | - ```bash |
| 38 | +```bash |
33 | 39 | git checkout -b <topic-branch-name> |
34 | 40 | ``` |
35 | 41 |
|
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. |
38 | 44 |
|
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. |
40 | 46 |
|
41 | | -6. Locally rebase the upstream development branch into your topic branch: |
| 47 | +#### 6. Locally rebase the upstream development branch into your topic branch: |
42 | 48 |
|
43 | | - ```bash |
| 49 | +```bash |
44 | 50 | git pull --rebase upstream dev |
45 | 51 | ``` |
46 | 52 |
|
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 |
50 | 55 | git push origin <topic-branch-name> |
51 | 56 | ``` |
52 | 57 |
|
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. |
54 | 59 |
|
55 | 60 | ## For maintainers |
56 | 61 |
|
|
0 commit comments