You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contributing-guidelines.md
+31-23Lines changed: 31 additions & 23 deletions
Original file line number
Diff line number
Diff line change
@@ -6,44 +6,52 @@ You can add new articles to either the Hacker Book or the Program Book.
6
6
#### Hacker Book
7
7
When adding a new article, make sure you format the file such that the first several lines of the markdown file are:
8
8
9
-
`---`<br>
10
-
`title: "Title of the Article"`<br>
11
-
`path: "/hackers/title-of-the-article.html"`<br>
12
-
`id: "hackers/title-of-the-article"`<br>
13
-
`---`
9
+
```md
10
+
---
11
+
title: "Title of the Article"
12
+
path: "/hackers/title-of-the-article.html"
13
+
id: "hackers/title-of-the-article"
14
+
---
15
+
```
14
16
15
17
#### Program Book
16
18
When adding a new article to the program book, make sure you format the file such that the first several lines of the markdown file are:
17
19
18
-
`---`<br>
19
-
`title: "Title of the Article"`<br>
20
-
`path: "/programs/title-of-the-article.html"`<br>
21
-
`id: "programs/title-of-the-article"`<br>
22
-
`---`
20
+
```md
21
+
---
22
+
title: "Title of the Article"
23
+
path: "/programs/title-of-the-article.html"
24
+
id: "programs/title-of-the-article"
25
+
---
26
+
```
23
27
24
28
#### Changelog Entry For a New Month
25
-
You can also add a changelog entry for a new month that isn't listed on the changelog yet. To add a changelog entry for a new month, make sure you format the file such that the firs several lines of the markdown file are:
29
+
You can also add a changelog entry for a new month that isn't listed on the changelog yet. To add a changelog entry for a new month, make sure you format the file such that the first several lines of the markdown file are:
26
30
27
-
`---`<br>
28
-
`title: "Month Year"`<br>
29
-
`path: "/changelog/[year]/[month]"`<br>
30
-
`date: "year-month number"`<br>
31
-
`---`
31
+
```md
32
+
---
33
+
title: "Month Year"
34
+
path: "/changelog/[year]/[month]"
35
+
date: "year-month number"
36
+
---
37
+
```
32
38
33
39
Example:
34
-
<br>`---`<br>
35
-
`title: "November 2016"`<br>
36
-
`path: "/changelog/2016/November"`<br>
37
-
`date: "2016-11"`<br>
38
-
`---`
40
+
```md
41
+
---
42
+
title: "November 2016"
43
+
path: "/changelog/2016/November"
44
+
date: "2016-11"
45
+
---
46
+
```
39
47
40
48
### Github Formatting
41
49
How do I... | Answer
42
50
----------- | -------
43
51
Add a link to a page within the docs site of the same book | `[Start H1 Response](start-h1-response.html)` or `[Start H1 Bounty](start-h1-bounty.html)`.
44
52
Add a link to a page within the docs site to an article in another book | `[Start H1 Bounty](/programs/start-h1-bounty.html)`
45
53
Add an image | ``
46
-
Referencing the HackerOne blog link | Use `https://hackerone.com/blog` not www.hackerone.com/blog
54
+
Reference the HackerOne blog link | Use `https://hackerone.com/blog` not www.hackerone.com/blog
47
55
48
56
### Active Voice
49
57
We use active voice at HackerOne as active voice is more personal and engaging vs. passive voice. In active voice, the subject does or acts upon the verb, while in passive voice, the subject is being acted upon.
@@ -60,7 +68,7 @@ In order to convey a personal and less formal voice, it's best to use contractio
60
68
Contraction - (Yes, please use this!) | Non-Contracted Phrases (Steer away from this)
0 commit comments