@@ -2,7 +2,7 @@ GitHub issues for BPO users
2
2
===========================
3
3
4
4
Here are some frequently asked quesions about how to do things in
5
- Github issues that you used to be able to do on `bpo `_.
5
+ GitHub issues that you used to be able to do on `bpo `_.
6
6
7
7
Before you ask your own question, make sure you read :doc: `tracker `
8
8
and :doc: `triaging ` (specifically including :doc: `gh-labels `) as those
@@ -11,7 +11,7 @@ pages include a lot of introductory material.
11
11
How to format my comments nicely?
12
12
---------------------------------
13
13
14
- There is a wonderful `beginner guide to writing and formatting on Github
14
+ There is a wonderful `beginner guide to writing and formatting on GitHub
15
15
<https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github> `_.
16
16
Highly recommended.
17
17
@@ -29,13 +29,13 @@ If you still insist on pasting it in your comment, do it like this::
29
29
How to attach files to an issue?
30
30
--------------------------------
31
31
32
- Drag them into the comment field, wait until the file uploads, and Github
32
+ Drag them into the comment field, wait until the file uploads, and GitHub
33
33
will automatically put a link to your file in your comment text.
34
34
35
35
How to link to file paths in the repository when writing comments?
36
36
------------------------------------------------------------------
37
37
38
- Use Markdown links. If you link to the default Github path, the file
38
+ Use Markdown links. If you link to the default GitHub path, the file
39
39
will link to the latest current version on the given branch.
40
40
41
41
You can get a permanent link to a given revision of a given file by
@@ -44,7 +44,7 @@ You can get a permanent link to a given revision of a given file by
44
44
How to do advanced searches?
45
45
----------------------------
46
46
47
- Use the `Github search syntax `_ or the interactive `advanced search `_ form
47
+ Use the `GitHub search syntax `_ or the interactive `advanced search `_ form
48
48
that generates search queries for you.
49
49
50
50
Where is the "nosy list"?
@@ -73,23 +73,23 @@ Add a checkbox list like this in the issue description::
73
73
- [ ] https://github.com/octo-org/octo-repo/issues/740
74
74
- [ ] Add delight to the experience when all tasks are complete :tada:
75
75
76
- then those will become sub-tasks on the given issue. Moreover, Github will
76
+ then those will become sub-tasks on the given issue. Moreover, GitHub will
77
77
automatically mark a task as complete if the other referenced issue is
78
- closed. More details in the `official Github documentation
78
+ closed. More details in the `official GitHub documentation
79
79
<https://docs.github.com/en/issues/tracking-your-work-with-issues/about-task-lists> `_.
80
80
81
81
What on Earth is a "mannequin"?
82
82
-------------------------------
83
83
84
- For issues migrated to Github from `bpo `_ where the authors or commenters
85
- are not core developers, we opted not to link to their Github accounts
86
- directly. Users not in the `python organization on Github
84
+ For issues migrated to GitHub from `bpo `_ where the authors or commenters
85
+ are not core developers, we opted not to link to their GitHub accounts
86
+ directly. Users not in the `python organization on GitHub
87
87
<https://github.com/orgs/python/people> `_ might not like comments to
88
- appear under their name from an automated import. Others never linked Github on
88
+ appear under their name from an automated import. Others never linked GitHub on
89
89
`bpo `_ in the first place so linking their account, if any, would be impossible.
90
90
91
91
In those cases a "mannequin" account is present to help follow the conversation
92
- that happened in the issue. In case the user did share their Github account
92
+ that happened in the issue. In case the user did share their GitHub account
93
93
name in their `bpo `_ profile, we use that. Otherwise, their classic `bpo `_
94
94
username is used instead.
95
95
@@ -106,7 +106,7 @@ Based on historical data we found those not being used very often.
106
106
How to find a random issue?
107
107
---------------------------
108
108
109
- This is not supported by Github .
109
+ This is not supported by GitHub .
110
110
111
111
Where are regression labels?
112
112
----------------------------
@@ -116,5 +116,5 @@ particularly useful outside of the change log.
116
116
117
117
118
118
.. _bpo : https://bugs.python.org/
119
- .. _ Github search syntax : https://docs.github.com/en/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax
119
+ .. _ GitHub search syntax : https://docs.github.com/en/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax
120
120
.. _advanced search : https://github.com/search/advanced
0 commit comments