@@ -44,20 +44,49 @@ You can do this by clicking the "Fork" button in the top right corner of the rep
44
44
The Python Packaging Guide is written in myST, a variant of MarkDown. You can edit the files directly in the GitHub website.
45
45
To do so, navigate to the file you want to edit and click the pencil icon in the top right corner of the file.
46
46
47
- ![ Edit file in GitHub] ( images/contributing/edit-file.png )
47
+ ``` {figure} images/contributing/edit-button-pencil.png
48
+ ---
49
+ name: edit-button-pencil in GitHub
50
+ width: 80%
51
+ alt: Edit button in GitHub
52
+ ---
53
+ An image showing how to edit a file in GitHub. The pencil icon is highlighted with a red circle.
54
+
55
+ ```{figure} images/contributing/edit-file.png
56
+ ---
57
+ name: edit-file in GitHub
58
+ width: 80%
59
+ alt: Edit file in GitHub
60
+ ---
61
+ An image showing when a file is being edited in GitHub. The file content is displayed in a text editor.
62
+ ```
48
63
49
64
To preview your changes, click the "Preview changes" tab.
50
65
51
- ![ Preview changes in GitHub] ( images/contributing/preview-changes.png )
66
+ ``` {figure} images/contributing/preview-changes.png
67
+ ---
68
+ name: preview-changes in GitHub
69
+ width: 80%
70
+ alt: Preview changes in GitHub
71
+ ---
72
+ An image showing how to preview changes in GitHub. The file content is displayed in a text editor.
73
+ ```
52
74
53
75
### How to commit your changes
54
76
55
77
When you are done editing the file, scroll down to the bottom of the page. You will see a section called "Commit changes".
56
78
Here you can write a title and a description for your changes. Make sure to write a clear and concise title that describes the changes you made.
57
79
58
- ![ Commit changes in GitHub] ( images/contributing/commit-changes.png )
80
+ ``` {figure} images/contributing/commit-changes.png
81
+ ---
82
+ name: commit-changes in GitHub
83
+ width: 80%
84
+ alt: Commit changes in GitHub
85
+ ---
86
+ An image showing how to commit changes in GitHub. The commit message is displayed in a text editor.
87
+ ```
59
88
60
- click on the "propose changes" button to submit your changes and open a pull request. See (How to make a pull request) [ #how-to-make-a-pull-request ] for more information .
89
+ After writing your commit message, click the "Commit changes" button to save your changes.
61
90
62
91
## Contributing locally on your computer
63
92
@@ -70,7 +99,14 @@ git clone <URL>
70
99
```
71
100
Replace ` <URL> ` with the URL of your forked repository. You can find the URL by clicking the green "Code" button on your forked repository page.
72
101
73
- ![ Clone repository] ( images/contributing/clone-repository.png )
102
+ ``` {figure} images/contributing/clone-repository.png
103
+ ---
104
+ name: clone-repository in GitHub
105
+ width: 80%
106
+ alt: Clone repository in GitHub
107
+ ---
108
+ An image showing how to clone a repository in GitHub. The URL of the repository is displayed in a text editor.
109
+ ```
74
110
75
111
### Create a new branch
76
112
@@ -170,11 +206,25 @@ Also make sure to check the formatting of your documentation by building the doc
170
206
171
207
1. To open a pull request on GitHub, navigate to the main page of your forked repository and click on the " Pull requests" tab.
172
208
173
- ! [Pull requests tab in GitHub](images/contributing/pull-requests-tab.png)
209
+ ` ` ` {figure} images/contributing/pull-requests-tab.png
210
+ ---
211
+ name: pull-requests-tab in GitHub
212
+ width: 80%
213
+ alt: Pull requests tab in GitHub
214
+ ---
215
+ An image showing how to navigate to the pull requests tab in GitHub.
216
+ ` ` `
174
217
175
218
2. Click on the " New pull request" button.
176
219
177
- ! [New pull request button in GitHub](images/contributing/new-pull-request.png)
220
+ ` ` ` {figure} images/contributing/new-pull-request.png
221
+ ---
222
+ name: new-pull-request in GitHub
223
+ width: 80%
224
+ alt: New pull request button in GitHub
225
+ ---
226
+ An image showing how to create a new pull request in GitHub.
227
+ ` ` `
178
228
179
229
3. Write a clear and concise title and description for your pull request. Make sure to describe the changes you made and why they are necessary.
180
230
@@ -187,11 +237,25 @@ Once you submit a pull request, a series of checks will be run to ensure that yo
187
237
188
238
You will see the status of these checks in your pull request.
189
239
190
- ! [Pull request checks in GitHub](images/contributing/pull-requests-checks.png)
191
-
240
+ ` ` ` {figure} images/contributing/pull-requests-checks.png
241
+ ---
242
+ name: pull-requests-checks in GitHub
243
+ width: 80%
244
+ alt: Pull request checks in GitHub
245
+ ---
246
+ An image showing the status of the checks in a pull request in GitHub.
247
+ ` ` `
192
248
If any of these checks fail, you will see an error message in your pull request. You need to fix the errors before your changes can be merged.
193
249
194
- ! [Pull request checks failed in GitHub](images/contributing/pull-requests-checks-fails.png)
250
+ ` ` ` {figure} images/contributing/pull-requests-checks-fails.png
251
+ ---
252
+ name: pull-requests-checks-fails in GitHub
253
+ width: 80%
254
+ alt: Pull request checks failed in GitHub
255
+ ---
256
+ An image showing the status of the checks in a pull request in GitHub.
257
+ ` ` `
258
+
195
259
To get more information about the errors, you can click on the " Details" link next to the failed check.
196
260
197
261
# ## What to expect from the review process
0 commit comments