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
+45-12Lines changed: 45 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,6 @@
1
-
# Style Guide
2
-
### Changelog
3
-
When adding a new entry to the changelog, make sure you format the file such that the first several lines of the markdown file are:
1
+
# Style Guide
4
2
5
-
`---`<br>
6
-
`title: "November 2016"`<br>
7
-
`path: "/changelog/2016/november"`<br>
8
-
`date: "2016-11"`<br>
9
-
`---`
10
-
11
-
### New Articles
3
+
### Adding New Articles
12
4
You can add new articles to either the Hacker Book or the Program Book.
13
5
14
6
#### Hacker Book
@@ -29,10 +21,51 @@ When adding a new article to the program book, make sure you format the file suc
29
21
`id: "programs/title-of-the-article"`<br>
30
22
`---`
31
23
32
-
### Formatting
24
+
#### 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:
26
+
27
+
`---`<br>
28
+
`title: "Month Year"`<br>
29
+
`path: "/changelog/[year]/[month]"`<br>
30
+
`date: "year-month number"`<br>
31
+
`---`
32
+
33
+
Example:
34
+
<br>`---`<br>
35
+
`title: "November 2016"`<br>
36
+
`path: "/changelog/2016/November"`<br>
37
+
`date: "2016-11"`<br>
38
+
`---`
39
+
40
+
### Github Formatting
33
41
How do I... | Answer
34
42
----------- | -------
35
43
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)`.
36
44
Add a link to a page within the docs site to an article in another book | `[Start H1 Bounty](/programs/start-h1-bounty.html)`
37
45
Add an image | ``
38
-
Referencing the HackerOne blog link | Use `https://hackerone.com/blog` not www.hackerone.com/bog
46
+
Referencing the HackerOne blog link | Use `https://hackerone.com/blog` not www.hackerone.com/blog
47
+
48
+
### Active Voice
49
+
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.
50
+
51
+
Active Voice (Yes, please use this!) | Passive Voice (Steer away from this)
Copy file name to clipboardExpand all lines: docs/programs/response-target-metrics.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ HackerOne tracks and enables you to define targets for these 4 response efficien
8
8
9
9
Response Efficiency Metric | Details
10
10
---- | -------
11
-
Time to first response | The elapsed time from when the report is submitted to the first public activity on a report. The first public activity includes adding a public comment, changing the report state, or changing the report severity.
11
+
Time to first response | The elapsed time from when the report is submitted, to the first public activity on a report. The first public activity includes adding a public comment, changing the report state, or changing the report severity.
12
12
Time to triage | The elapsed time from when a report is submitted to when a report is changed to a triaged state. A report can skip the triaged state and move directly to a closed state (e.g. resolved).
13
13
Time to bounty | *(Bounty programs only)* The elapsed time from when a report is triaged to when a bounty is paid. Only reports that are eligible for a bounty will be tracked as part of this metric. The time to bounty timer will run until the report is either marked as ineligible or closed as a state where it’s not normal to award a bounty (e.g. spam).<br><br><i>Awarding swag in lieu of a bounty won't stop the timer. If you only award a report with swag, you must mark the report as ineligible for bounty to stop the timer</i>.
14
14
Time to resolution | The elapsed time from when a report is submitted to when a report is closed. These five closed report states will stop the timer: <i>resolved, informative, not applicable, duplicate,</i> and <i>spam</i>. For programs using [human-augmented signal](human-augmented-signal.html), the resolution timer starts when the report has been approved by HackerOne Security Analysts and escalated to the customer's inbox.
0 commit comments