Skip to content

Commit 02b8109

Browse files
IonicaBizauindutny
authored andcommitted
docs: highlight shell-codes in CONTRIBUTING.md
Signed-off-by: Fedor Indutny <[email protected]>
1 parent 423725b commit 02b8109

File tree

2 files changed

+44
-26
lines changed

2 files changed

+44
-26
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ through the process.
99
Fork the project [on GitHub](https://github.com/joyent/node) and check out
1010
your copy.
1111

12-
```
12+
```sh
1313
$ git clone [email protected]:username/node.git
1414
$ cd node
1515
$ git remote add upstream git://github.com/joyent/node.git
@@ -48,7 +48,7 @@ does not align with that of a project maintainer.
4848
Okay, so you have decided on the proper branch. Create a feature branch
4949
and start hacking:
5050

51-
```
51+
```sh
5252
$ git checkout -b my-feature-branch -t origin/v0.10
5353
```
5454

@@ -59,7 +59,7 @@ $ git checkout -b my-feature-branch -t origin/v0.10
5959

6060
Make sure git knows your name and email address:
6161

62-
```
62+
```sh
6363
$ git config --global user.name "J. Random User"
6464
$ git config --global user.email "[email protected]"
6565
```
@@ -99,7 +99,7 @@ what subsystem (or subsystems) your changes touch.
9999

100100
Use `git rebase` (not `git merge`) to sync your work from time to time.
101101

102-
```
102+
```sh
103103
$ git fetch upstream
104104
$ git rebase upstream/v0.10 # or upstream/master
105105
```
@@ -111,7 +111,7 @@ Bug fixes and features should come with tests. Add your tests in the
111111
test/simple/ directory. Look at other tests to see how they should be
112112
structured (license boilerplate, common includes, etc.).
113113

114-
```
114+
```sh
115115
$ make jslint test
116116
```
117117

@@ -134,7 +134,7 @@ node ./test/simple/test-streams2-transform.js
134134

135135
### PUSH
136136

137-
```
137+
```sh
138138
$ git push origin my-feature-branch
139139
```
140140

README.md

Lines changed: 38 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,32 @@ Prerequisites (Unix only):
1212

1313
Unix/Macintosh:
1414

15-
./configure
16-
make
17-
make install
15+
```sh
16+
./configure
17+
make
18+
make install
19+
```
1820

1921
With libicu i18n support:
2022

21-
svn checkout --force --revision 214189 \
22-
http://src.chromium.org/svn/trunk/deps/third_party/icu46 \
23-
deps/v8/third_party/icu46
24-
./configure --with-icu-path=deps/v8/third_party/icu46/icu.gyp
25-
make
26-
make install
23+
```sh
24+
svn checkout --force --revision 214189 \
25+
http://src.chromium.org/svn/trunk/deps/third_party/icu46 \
26+
deps/v8/third_party/icu46
27+
./configure --with-icu-path=deps/v8/third_party/icu46/icu.gyp
28+
make
29+
make install
30+
```
2731

2832
If your python binary is in a non-standard location or has a
2933
non-standard name, run the following instead:
3034

31-
export PYTHON=/path/to/python
32-
$PYTHON ./configure
33-
make
34-
make install
35+
```sh
36+
export PYTHON=/path/to/python
37+
$PYTHON ./configure
38+
make
39+
make install
40+
```
3541

3642
Prerequisites (Windows only):
3743

@@ -48,30 +54,42 @@ and OS X installers will prompt you for the location to install to.
4854
The tarballs are self-contained; you can extract them to a local directory
4955
with:
5056

51-
tar xzf /path/to/node-<version>-<platform>-<arch>.tar.gz
57+
```sh
58+
tar xzf /path/to/node-<version>-<platform>-<arch>.tar.gz
59+
```
5260

5361
Or system-wide with:
5462

55-
cd /usr/local && tar --strip-components 1 -xzf \
56-
/path/to/node-<version>-<platform>-<arch>.tar.gz
63+
```sh
64+
cd /usr/local && tar --strip-components 1 -xzf \
65+
/path/to/node-<version>-<platform>-<arch>.tar.gz
66+
```
5767

5868
### To run the tests:
5969

6070
Unix/Macintosh:
6171

62-
make test
72+
```sh
73+
make test
74+
```
6375

6476
Windows:
6577

66-
vcbuild test
78+
```sh
79+
vcbuild test
80+
```
6781

6882
### To build the documentation:
6983

70-
make doc
84+
```sh
85+
make doc
86+
```
7187

7288
### To read the documentation:
7389

74-
man doc/node.1
90+
```sh
91+
man doc/node.1
92+
```
7593

7694
Resources for Newcomers
7795
---

0 commit comments

Comments
 (0)