Skip to content

Commit afc4ab3

Browse files
authored
Update CONTRIBUTING.md
1 parent ae5d769 commit afc4ab3

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,8 @@ You can preview changes locally before pushing them to GitHub. To do this:
127127
2. Install dependencies and serve the site:
128128

129129
```console
130-
$ scripts/install-mkdocs.sh # requires pip
131-
$ mkdocs serve
130+
scripts/install-mkdocs.sh # requires pip
131+
mkdocs serve
132132
```
133133

134134
This will run the site locally so you can preview your changes. Note that some features are disabled in local builds.
@@ -138,14 +138,14 @@ You can preview changes locally before pushing them to GitHub. To do this:
138138
- **Git Revision Date Plugin**: Disabled by default but can be enabled with:
139139

140140
```console
141-
$ export MKDOCS_ENABLE_GIT_REVISION_DATE=True
141+
export MKDOCS_ENABLE_GIT_REVISION_DATE=True
142142
```
143143

144144
- **Git Committers Plugin**: Disabled by default, as it requires a GitHub personal access token. Enable it like this:
145145

146146
```console
147-
$ export MKDOCS_ENABLE_GIT_COMMITTERS=True
148-
$ export MKDOCS_GIT_COMMITTERS_APIKEY=your_token_here
147+
export MKDOCS_ENABLE_GIT_COMMITTERS=True
148+
export MKDOCS_GIT_COMMITTERS_APIKEY=your_token_here
149149
```
150150

151151
You can generate your token [here](https://github.com/settings/tokens). Only public access permissions are needed.
@@ -155,19 +155,21 @@ You can preview changes locally before pushing them to GitHub. To do this:
155155
If your article includes code snippets, it’s helpful to include tests to ensure that they run correctly.
156156

157157
1. Name the code snippet:
158-
```{.cpp file=snippet-name}
158+
159+
```{.cpp file=snippet-name}
159160
// code here
160161
```
161-
2. Run `extract_snippets.py` from the `test` directory to extract snippets into header files. Create a test file that includes these headers and checks their behavior.
162-
3. You can run all tests with the `test.sh` script:
162+
163+
3. Run `extract_snippets.py` from the `test` directory to extract snippets into header files. Create a test file that includes these headers and checks their behavior.
164+
4. You can run all tests with the `test.sh` script:
163165
```console
164-
$ cd test
165-
$ ./test.sh
166+
cd test
167+
./test.sh
166168
```
167169
**Example Output:**
168170
```
169171
Running test_aho_corasick.cpp - Passed in 635 ms
170-
Running test_balanced_brackets.cpp - Passed in 1390 ms
172+
Running test_balanced_brackets.cpp - Passed in 1390 ms
171173
Running test_burnside_tori.cpp - Passed in 378 ms
172174
...
173175
51 PASSED in 49.00 seconds

0 commit comments

Comments
 (0)