Skip to content

Commit 1e0a1a3

Browse files
nschonniTrott
authored andcommitted
fix: Collaborator Guide (#2712)
- Replace inline triple backticks - Add code fence languages - behaviour -> behavior - contstraints -> constraints - Remove bold as heading
1 parent fecb264 commit 1e0a1a3

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

Diff for: COLLABORATOR_GUIDE.md

+11-13
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Node.js Collaborator Guide
22

3-
**Contents**
4-
53
* [Issues and Pull Requests](#issues-and-pull-requests)
64
* [Accepting Modifications](#accepting-modifications)
75
* [Involving the Website Group](#involving-the-website-group)
@@ -61,7 +59,7 @@ from other Collaborators. Leave at least 48 hours during the week and
6159
and work schedules. Trivial changes (e.g. those which fix minor bugs
6260
or improve performance without affecting API or causing other
6361
wide-reaching impact) may be landed after a shorter delay. Any press
64-
release can land with no time contstraints as long as the copy is
62+
release can land with no time constraints as long as the copy is
6563
properly formatted, it is not the responsibility of the website group
6664
to review the copy itself.
6765

@@ -135,7 +133,7 @@ CoC](https://github.com/rust-lang/rust/wiki/Note-development-policy#conduct).
135133
* Please keep unstructured critique to a minimum. If you have solid
136134
ideas you want to experiment with, make a fork and see how it works.
137135
* We will exclude you from interaction if you insult, demean or harass
138-
anyone. That is not welcome behaviour. We interpret the term
136+
anyone. That is not welcome behavior. We interpret the term
139137
"harassment" as including the definition in the [Citizen Code of
140138
Conduct](http://citizencodeofconduct.org/); if you have any lack of
141139
clarity about what might be included in that concept, please read
@@ -149,7 +147,7 @@ CoC](https://github.com/rust-lang/rust/wiki/Note-development-policy#conduct).
149147
a newcomer, we care about making this community a safe place for you
150148
and we've got your back.
151149
* Likewise any spamming, trolling, flaming, baiting or other
152-
attention-stealing behaviour is not welcome.
150+
attention-stealing behavior is not welcome.
153151
* Avoid the use of personal pronouns in code comments or
154152
documentation. There is no need to address persons when explaining
155153
code (e.g. "When the developer")
@@ -159,17 +157,17 @@ CoC](https://github.com/rust-lang/rust/wiki/Note-development-policy#conduct).
159157
### Adding new pages
160158

161159
1. Create new page content including the layout, title and copy.
162-
2. Update ```/locale/en/site.json``` to provide page link attributes.
163-
3. Update the relevant ```/layout``` to add a link to the new page.
160+
2. Update `/locale/en/site.json` to provide page link attributes.
161+
3. Update the relevant `/layout` to add a link to the new page.
164162

165163
#### Create the page content
166164

167-
Create a new markdown file in ```/local/en```. As specified in the
165+
Create a new markdown file in `/local/en`. As specified in the
168166
[README.md](./README.md#layout), initial development happens in English.
169167

170168
At the top of the markdown file, set a page the title and layout.
171169

172-
```
170+
```markdown
173171
---
174172
title: Events
175173
layout: contribute.hbs
@@ -180,10 +178,10 @@ layout: contribute.hbs
180178

181179
#### Update locale site.json to add link attributes
182180

183-
Open ```local/en/site.json``` and find the appropriate page structure.
181+
Open `local/en/site.json` and find the appropriate page structure.
184182
Add a new object defining the link attributes.
185183

186-
```
184+
```json
187185
"event": {
188186
"link": "get-involved/events",
189187
"text": "Events"
@@ -192,10 +190,10 @@ Add a new object defining the link attributes.
192190

193191
#### Update the layout to add a link
194192

195-
Using the example layout, open ```/layouts/contribute.hbs``` and add your new
193+
Using the example layout, open `/layouts/contribute.hbs` and add your new
196194
link to the markup. It's essential to update the handlebars paths to site.json.
197195

198-
```
196+
```handlebars
199197
{{site.locale}}/{{site.getinvolved.events.link}}
200198
```
201199

0 commit comments

Comments
 (0)