Skip to content

Update readme to include review guidelines #261

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
zhaoqizqwang merged 5 commits into from
Sep 10, 2025
Merged

Update readme to include review guidelines #261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
df339cf
Update PR template
zhaoqizqwang Sep 10, 2025
1d53a7d
Update template
zhaoqizqwang Sep 10, 2025
59c5b95
Update template format
zhaoqizqwang Sep 10, 2025
6353396
Update format
zhaoqizqwang Sep 10, 2025
32a8267
Fix readme
zhaoqizqwang Sep 10, 2025
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
33 changes: 14 additions & 19 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,17 @@
<!-- Describe your testing approach -->


## Unit test coverage
<!-- Check unit test coverage for your changes -->
- [ ] All new/modified code has unit tests
- [ ] Coverage verified for changed code
- [ ] N/A - no testable code changes

## Do we need integration tests?
<!-- Consider if integration tests are needed -->
- [ ] Yes - integration tests added
- [ ] No - unit tests sufficient
- [ ] No - infrastructure/config change only
- [ ] Unsure - please advise

---

## Checklist
- [ ] PR title clearly describes the change
- [ ] No sensitive information exposed and security is maintained
- [ ] Ready for review
## Are unit tests added?


## Are integration tests added?


## Reviewer Guidelines

‼️ **Merge Requirements**: PRs with failing integration tests cannot be merged without justification.

One of the following must be true:
- [ ] All automated PR checks pass
- [ ] Failed tests include local run results/screenshots proving they work
- [ ] Changes are documentation-only
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,11 @@ doc/_build/
/sagemaker-hyperpod/build
/sagemaker-hyperpod/.coverage
/sagemaker-hyperpod/.coverage.*

/hyperpod-cluster-stack-template/build
/hyperpod-pytorch-job-template/build
/hyperpod-custom-inference-template/build
/hyperpod-jumpstart-inference-template/build

# Ignore all contents of result and results directories
/result/
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ hyp list-cluster
|--------|------|-------------|
| `--region <region>` | Optional | The region that the SageMaker HyperPod and EKS clusters are located. If not specified, it will be set to the region from the current AWS account credentials. |
| `--namespace <namespace>` | Optional | The namespace that users want to check the quota with. Only the SageMaker managed namespaces are supported. |
| `--output <json|table>` | Optional | The output format. Available values are `table` and `json`. The default value is `json`. |
| `--output <json\|table>` | Optional | The output format. Available values are `table` and `json`. The default value is `json`. |
| `--debug` | Optional | Enable debug mode for detailed logging. |

### Connecting to a Cluster
Expand Down
Loading