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
* Read through the article once, noting barriers to readability.
21
+
* Note barriers to scannability.
22
+
* Note content with the weakest plain language usage.
23
+
* Make changes according to the guidelines below.
24
+
* Only analyze and edit the specific .md files provided.
25
+
* Do not move or delete files, but you may suggest splitting or renaming if it improves the docs.
26
+
* Make edits only when they provide meaningful improvements. Do not revise purely for minor aesthetics.
27
+
* After making edits, review each change to verify the original meaning is preserved. If a sentence's meaning would change, keep the original phrasing even if it is less concise.
28
+
* Do not remove sentences about defaults, feature scope, or access unless clearly repeated.
## Editing Guidelines and Plain Language Principles
32
33
33
34
### Writing Style
34
35
35
-
- Use concise, everyday language. Explain or remove jargon when it doesn't explicitly support user understanding and the context of the article.
36
-
- When two possible phrasings are equally clear, choose the one with fewer words. Brevity directly improves readability.
37
-
- Use full terms and not their shortened versions.
38
-
- Use active voice and personal pronouns ("you," "your"); favor present tense.
39
-
- When “you can” introduces an instruction and does not convey optionality or permission, replace it with an active verb. For example, “You can enable” becomes “Enable”. Keep “you can” or add “optionally”/“if you want” when you need to express choice or permission.
40
-
- Retain essential technical details, such as defaults, warnings, and admin options.
41
-
- Do not alter the intent of verbs and actions (ex. "navigate" does not necessarily mean "select").
42
-
- Start at least half of steps or instructions with a direct verb, unless another structure improves clarity.
43
-
- Use sentence case for headings and list items (capitalize only the first word and proper nouns).
44
-
- Match names of buttons, menus, and UI elements exactly as they appear in the original documentation. Do not paraphrase.
36
+
* Use concise, everyday language. Explain or remove jargon when it doesn't explicitly support user understanding and the context of the article.
37
+
* When two possible phrasings are equally clear, choose the one with fewer words. Brevity directly improves readability.
38
+
* Use full terms and not their shortened versions.
39
+
* Use active voice and personal pronouns ("you," "your"); favor present tense.
40
+
* When "you can" introduces an instruction and does not convey optionality or permission, replace it with an active verb. For example, "You can enable" becomes "Enable". Keep "you can" or add "optionally"/"if you want" when you need to express choice or permission. When in doubt about whether "you can" conveys optionality, keep it.
41
+
* Retain essential technical details, such as defaults, warnings, and admin options.
42
+
* Do not alter the intent of verbs and actions (ex. "navigate" does not necessarily mean "select").
43
+
* Never change the fundamental meaning of a sentence. Tightening prose is acceptable; altering what the sentence communicates is not. Specifically:
44
+
* Do not remove qualifiers like "we recommend," "we strongly recommend," or "it's best to" — these convey the strength of guidance.
45
+
* Do not remove connective phrases like "To do this," "The following," or "For more information" that orient the reader.
46
+
* Do not convert a description of capability ("Copilot can load tools when relevant") into a statement of fact ("Copilot loads tools when relevant").
47
+
* Do not change referential phrases like "the following" to "these" when "the following" points forward to a specific list or table.
48
+
* Start at least half of steps or instructions with a direct verb, unless another structure improves clarity.
49
+
* Use sentence case for headings and list items (capitalize only the first word and proper nouns).
50
+
* Match names of buttons, menus, and UI elements exactly as they appear in the original documentation. Do not paraphrase.
45
51
46
52
### Structure
47
53
48
-
- Don’t append new information or expository text to existing content.
49
-
- Structure logically with clear, descriptive headings, short sections, and organized (bulleted or numbered) lists.
50
-
- Do not create new headers if they would only have one sentence worth of content.
51
-
- End every list item with a period if it is a complete sentence; omit periods for list fragments or single-word items.
54
+
* Don't append new information or expository text to existing content. Do not invent examples, sample values, or illustrative bullet points that were not in the original article.
55
+
* Structure logically with clear, descriptive headings, short sections, and organized (bulleted or numbered) lists.
56
+
* Do not create new headers if they would only have one sentence worth of content.
57
+
* End every list item with a period if it is a complete sentence; omit periods for list fragments or single-word items.
52
58
53
59
### Paragraphs
54
60
55
-
- State the topic at the start of each paragraph; clarify connections between paragraphs.
56
-
- Limit paragraphs to 150 words or fewer.
57
-
- Split a paragraph or list item when it includes two topics or steps.
61
+
* State the topic at the start of each paragraph; clarify connections between paragraphs.
62
+
* Limit paragraphs to 150 words or fewer.
63
+
* Split a paragraph or list item when it includes two topics or steps.
58
64
59
65
### Sentences
60
66
61
-
- Write one idea per sentence; avoid redundancy, vague modifiers, and ambiguous phrasing.
62
-
- Avoid consecutive sentences starting the same way.
63
-
- Make sure no more than 25% of sentences contain more than 20 words.
64
-
- Split sentences that contain multiple clauses into separate sentences.
67
+
* Write one idea per sentence; avoid redundancy, vague modifiers, and ambiguous phrasing.
68
+
* Avoid consecutive sentences starting the same way.
69
+
* Make sure no more than 25% of sentences contain more than 20 words.
70
+
* Split sentences that contain multiple clauses into separate sentences.
65
71
66
72
## References
67
73
68
74
These PRs demonstrate successful improvement in readability:
Copy file name to clipboardExpand all lines: content/actions/reference/workflows-and-actions/contexts.md
+36-2Lines changed: 36 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -378,15 +378,23 @@ The `job` context contains information about the currently running job.
378
378
| `job.services.<service_id>.network` | `string` | The ID of the service container network. The runner creates the network used by all containers in a job. |
379
379
| `job.services.<service_id>.ports` | `object` | The exposed ports of the service container. |
380
380
| `job.status` | `string` | The current status of the job. Possible values are `success`, `failure`, or `cancelled`. |
381
+
| `job.workflow_ref` | `string` | The full ref of the workflow file that defines the current job. For example, `octo-org/octo-repo/.github/workflows/deploy.yml@refs/heads/main`. For jobs defined directly in a workflow file, this is the same as `github.workflow_ref`. For jobs defined in a [AUTOTITLE](/actions/using-workflows/reusing-workflows), this refers to the reusable workflow file. (not available on {% data variables.product.prodname_ghe_server %}) |
382
+
| `job.workflow_sha` | `string` | The commit SHA of the workflow file that defines the current job. (not available on {% data variables.product.prodname_ghe_server %}) |
383
+
| `job.workflow_repository` | `string` | The `owner/repo` of the repository containing the workflow file that defines the current job. For example, `octo-org/octo-repo`. (not available on {% data variables.product.prodname_ghe_server %}) |
384
+
| `job.workflow_file_path` | `string` | The file path of the workflow file that defines the current job, relative to the repository root. For example, `.github/workflows/deploy.yml`. (not available on {% data variables.product.prodname_ghe_server %}) |
381
385
382
386
### Example contents of the `job` context
383
387
384
-
This example `job` context uses a PostgreSQL service container with mapped ports. If there are no containers or service containers used in a job, the `job` context only contains the `status` and `check_run_id` properties.
388
+
This example `job` context uses a PostgreSQL service container with mapped ports. If there are no containers or service containers used in a job, the `job` context only contains `status`. The `check_run_id` and workflow identity properties (`workflow_ref`, `workflow_sha`, `workflow_repository`, `workflow_file_path`) are not available on {% data variables.product.prodname_ghe_server %}.
385
389
386
390
```json
387
391
{
388
392
"status": "success",
389
-
{% ifversion fpt or ghec %}"check_run_id": 51725241954,{% endif %}
### Example usage of `job` context workflow identity
439
+
440
+
> [!NOTE]
441
+
> The `job.workflow_*` context properties are not available on {% data variables.product.prodname_ghe_server %}.
442
+
443
+
This example reusable workflow uses `job.workflow_repository` and `job.workflow_sha` to check out its own source code, rather than the caller's repository. This is useful when a reusable workflow needs to access files co-located with the workflow definition.
444
+
445
+
```yaml copy
446
+
# In a reusable workflow (e.g., octo-org/shared-workflows/.github/workflows/deploy.yml)
447
+
name: Reusable deploy workflow
448
+
on:
449
+
workflow_call:
450
+
451
+
jobs:
452
+
deploy:
453
+
runs-on: ubuntu-latest
454
+
steps:
455
+
- uses: {% data reusables.actions.action-checkout %}
456
+
with:
457
+
repository: {% raw %}${{ job.workflow_repository }}{% endraw %}
458
+
ref: {% raw %}${{ job.workflow_sha }}{% endraw %}
459
+
460
+
- run: echo "Deploying from {% raw %}${{ job.workflow_ref }}{% endraw %}"
461
+
- run: echo "Workflow file path is {% raw %}${{ job.workflow_file_path }}{% endraw %}"
462
+
```
463
+
430
464
## `jobs` context
431
465
432
466
The `jobs` context is only available in reusable workflows, and can only be used to set outputs for a reusable workflow. For more information, see [AUTOTITLE](/actions/using-workflows/reusing-workflows#using-outputs-from-a-reusable-workflow).
Copy file name to clipboardExpand all lines: content/copilot/concepts/billing/billing-for-individuals.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ category:
17
17
---
18
18
19
19
> [!IMPORTANT]
20
-
> {% data reusables.copilot.plans.individual-plans-paused %} If you hit unexpected limits as a result of these changes, you can cancel your Pro or Pro+ subscription and you will not be charged for April usage. Please reach out to [GitHub support](https://support.github.com/) between April 20 and May 20, 2026, for a refund.
20
+
> {% data reusables.copilot.plans.individual-plans-paused %} If you hit unexpected limits as a result of these changes, you can cancel your Pro or Pro+ subscription and receive a refund for the time remaining on your current subscription. Please reach out to [GitHub support](https://support.github.com/) between April 20 and May 20, 2026, for a refund.
21
21
22
22
## Pricing for {% data variables.copilot.copilot_pro_short %} and {% data variables.copilot.copilot_pro_plus_short %}
Copy file name to clipboardExpand all lines: content/copilot/reference/copilot-billing/license-changes.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ contentType: reference
11
11
---
12
12
13
13
> [!IMPORTANT]
14
-
> **Starting April 20, 2026**, new sign-ups for {% data variables.copilot.copilot_pro_short %}, {% data variables.copilot.copilot_pro_plus_short %}, and student plans are temporarily paused. However, existing {% data variables.product.prodname_copilot_short %} plans can still be upgraded, downgraded, or canceled. If you hit unexpected limits as a result of these changes, you can cancel your Pro or Pro+ subscription and you will not be charged for April usage. Please reach out to [GitHub support](https://support.github.com/) between April 20 and May 20, 2026, for a refund.
14
+
> **Starting April 20, 2026**, new sign-ups for {% data variables.copilot.copilot_pro_short %}, {% data variables.copilot.copilot_pro_plus_short %}, and student plans are temporarily paused. However, existing {% data variables.product.prodname_copilot_short %} plans can still be upgraded, downgraded, or canceled. If you hit unexpected limits as a result of these changes, you can cancel your Pro or Pro+ subscription and receive a refund for the time remaining on your current subscription. Please reach out to [GitHub support](https://support.github.com/) between April 20 and May 20, 2026, for a refund.
15
15
16
16
{% data variables.product.prodname_copilot_short %} follows the same billing rules as other license-based products on {% data variables.product.company_short %}.
0 commit comments