Skip to content

Commit e214f65

Browse files
author
Sarah Edwards
authored
add guidance on scheduled workflow examples (github#18417)
1 parent a9bee89 commit e214f65

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

contributing/content-style-guide.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ These guidelines are specific to GitHub’s documentation. For general style que
1313
- [Commands](#commands)
1414
- [Examples](#examples)
1515
- [Indentation](#indentation)
16+
- [Scheduled workflows](#scheduled-workflows)
1617
- [Headers](#headers)
1718
- [Images](#images)
1819
- [Alt text](#alt-text)
@@ -145,6 +146,14 @@ In YAML examples, such as actions and workflow files, use two spaces to indent l
145146
python-version: ${{ matrix.python }}
146147
```
147148
149+
### Scheduled workflows
150+
151+
Workflow runs are delayed when too many workflows run at once. Since many users copy code from the GitHub docs, we should use examples that guide users away from congested times.
152+
153+
- Do not use examples that run on the hour. (The Actions team reports that times at the start of the hour, especially UTC midnight, are disproportionately overloaded.)
154+
- Do not use examples that run more frequently than necessary. For example, instead of running every 5 minutes, consider if the example makes sense to run every 30 minutes instead.
155+
- Use a different time for each example.
156+
148157
## Headers
149158
150159
Use H3 for headers, and H4 for subheaders. When referring to headers, surround the header name with quotation marks.

0 commit comments

Comments
 (0)