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
Copy file name to clipboardExpand all lines: .github/pull_request_template.md
+19-13Lines changed: 19 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,14 @@
2
2
3
3
<!-- Provide a detailed description of the changes in this PR -->
4
4
5
+
#### Usage
6
+
7
+
<!--- How does a user interact with the changed code -->
8
+
9
+
```python
10
+
TODO: Add code snippet
11
+
```
12
+
5
13
### Type of changes
6
14
7
15
<!-- Mark the relevant option with an [x] -->
@@ -14,14 +22,20 @@
14
22
15
23
### CI Pipeline Configuration
16
24
17
-
Configure CI behavior by applying the relevant labels:
25
+
Configure CI behavior by applying the relevant labels. By default, only basic unit tests are run.
26
+
27
+
-[ciflow:skip](https://github.com/NVIDIA/bionemo-framework/blob/main/docs/docs/main/contributing/contributing.md#ciflow:skip) - Skip all CI tests for this PR
28
+
-[ciflow:notebooks](https://github.com/NVIDIA/bionemo-framework/blob/main/docs/docs/main/contributing/contributing.md#ciflow:notebooks) - Run Jupyter notebooks execution tests for bionemo2
29
+
-[ciflow:slow](https://github.com/NVIDIA/bionemo-framework/blob/main/docs/docs/main/contributing/contributing.md#ciflow:slow) - Run slow single GPU integration tests marked as @pytest.mark.slow for bionemo2
30
+
-[ciflow:all](https://github.com/NVIDIA/bionemo-framework/blob/main/docs/docs/main/contributing/contributing.md#ciflow:all) - Run all tests (unit tests, slow tests, and notebooks) for bionemo2. This label can be used to enforce running tests for all bionemo2.
31
+
-[ciflow:all-recipes](https://github.com/NVIDIA/bionemo-framework/blob/main/docs/docs/main/contributing/contributing.md#ciflow:all-recipes) - Run tests for all recipes (under bionemo-recipes). This label can be used to enforce running tests for all recipes.
18
32
19
-
-[SKIP_CI](https://github.com/NVIDIA/bionemo-framework/blob/main/docs/docs/user-guide/contributing/contributing.md#skip_ci) - Skip all continuous integration tests
20
-
-[INCLUDE_NOTEBOOKS_TESTS](https://github.com/NVIDIA/bionemo-framework/blob/main/docs/docs/user-guide/contributing/contributing.md#include_notebooks_tests) - Execute notebook validation tests in pytest
21
-
-[INCLUDE_SLOW_TESTS](https://github.com/NVIDIA/bionemo-framework/blob/main/docs/docs/user-guide/contributing/contributing.md#include_slow_tests) - Execute tests labelled as slow in pytest for extensive testing
33
+
Unit tests marked as `@pytest.mark.multi_gpu` or `@pytest.mark.distributed` are not run in the PR pipeline.
34
+
35
+
For more details, see [CONTRIBUTING](CONTRIBUTING.md)
22
36
23
37
> [!NOTE]
24
-
> By default, the notebooks validation tests are skipped unless explicitly enabled.
38
+
> By default, only basic unit tests are run. Add appropriate labels to enable an additional test coverage.
25
39
26
40
#### Authorizing CI Runs
27
41
@@ -33,14 +47,6 @@ runs on NVIDIA's compute resources.
33
47
- If a pull request is opened by an untrusted user or contains untrusted changes, an NVIDIA org member must leave an
34
48
`/ok to test` comment on the pull request to trigger CI. This will need to be done for each new commit.
35
49
36
-
### Usage
37
-
38
-
<!--- How does a user interact with the changed code -->
39
-
40
-
```python
41
-
#TODO: Add code snippet
42
-
```
43
-
44
50
### Pre-submit Checklist
45
51
46
52
<!--- Ensure all items are completed before submitting -->
0 commit comments