@@ -178,8 +178,6 @@ Also make sure to check the formatting of your documentation by building the doc
178
178
179
179
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
180
181
- * __TODO__: This section should describe how to make a pull request in GitHub.*
182
-
183
181
# ## What happens when you submit a pull request (CI/CD)
184
182
185
183
Once you submit a pull request, a series of checks will be run to ensure that your changes do not introduce any bugs or errors. These checks include:
@@ -189,16 +187,13 @@ Once you submit a pull request, a series of checks will be run to ensure that yo
189
187
190
188
You will see the status of these checks in your pull request.
191
189
192
- ! [Pull request checks in GitHub](images/contributing/pull-request -checks.png)
190
+ ! [Pull request checks in GitHub](images/contributing/pull-requests -checks.png)
193
191
194
192
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.
195
193
196
- ! [Pull request checks failed in GitHub](images/contributing/pull-request -checks-failed .png)
194
+ ! [Pull request checks failed in GitHub](images/contributing/pull-requests -checks-fails .png)
197
195
To get more information about the errors, you can click on the " Details" link next to the failed check.
198
196
199
-
200
- * __TODO__: This section should describe how to see the results of the CD/CI checks and how to get more information about errors*
201
-
202
197
# ## What to expect from the review process
203
198
204
199
Once you submit a pull request, a maintainer of the repository will review your changes and provide feedback. The review process may involve:
@@ -211,8 +206,6 @@ You can make changes to your pull request by pushing new commits to the branch.
211
206
212
207
Once your pull request is approved, it will be merged into the main branch and your changes will be included in the guide.
213
208
214
- * __TODO__: This section should describe how review happens in GitHub, how see the comments, and how to submit changes (push a new branch)*
215
-
216
209
# # Additional help
217
210
218
211
# ## How to get help
0 commit comments