Skip to content

documentation: clarify when tests should be marked as a canary #2058

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 24, 2020
Merged

documentation: clarify when tests should be marked as a canary #2058

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ If you are writing or modifying a test that creates a SageMaker job (training, t
1. Run all the unit tests as per [Run the Unit Tests](#run-the-unit-tests), and verify that all checks and tests pass.
1. Note that this also runs tools that may be necessary for the automated build to pass (ex: code reformatting by 'black').
1. If your changes include documentation changes, please see the [Documentation Guidelines](#documentation-guidelines).
1. If you include integration tests, do not mark them as canaries if they will not run in all regions.


### Commit Your Change
Expand Down