Skip to content

Commit 38982a4

Browse files
docs: add images for Pr fails
1 parent b5f296a commit 38982a4

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -184,11 +184,16 @@ Also make sure to check the formatting of your documentation by building the doc
184184

185185
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:
186186

187-
- **Code formatting**: checks that your code is formatted correctly.
188-
- **Code style**: checks that your code follows the style guidelines.
189-
- **Tests**: runs the tests to ensure that your changes do not break any existing functionality.
187+
- **Code formatting and styles**: checks that your code is formatted correctly, by `pre-commit.ci - pr check`.
188+
- **docs build**: checks that the documentation builds correctly, using `circleci`.
189+
190+
You will see the status of these checks in your pull request.
191+
192+
![Pull request checks in GitHub](images/contributing/pull-request-checks.png)
190193

191194
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+
196+
![Pull request checks failed in GitHub](images/contributing/pull-request-checks-failed.png)
192197
To get more information about the errors, you can click on the "Details" link next to the failed check.
193198

194199

Loading
17.2 KB
Loading

0 commit comments

Comments
 (0)