Skip to content

Add how-to-test & docs check to PR templates #31

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

Open
pavithraes wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add how-to-test & docs check to PR templates #31

Show file tree
Hide file tree
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
5 changes: 5 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ _Put a `x` in the boxes that apply_
- [ ] Did you test the pull request locally?
- [ ] Did you add new tests?

### How to test

<!-- Steps to take to test the new feature, verify the bug is fixed, etc.
Please do not just include steps for the happy path, but failure modes too. -->

## Documentation

<!--
Expand Down
10 changes: 9 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE_simple.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,25 @@ _Put a `x` in the boxes that apply_
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds a feature)
- [ ] Breaking change (fix or feature that would cause existing features not to work as expected)
- [ ] Documentation Update
- [ ] Code style update (formatting, renaming)
- [ ] Refactoring (no functional changes, no API changes)
- [ ] Build related changes
- [ ] Other (please describe):

## Documentation

- [ ] Did you add/update relevant documentation (in [nebari-dev/nebari-docs](https://github.com/nebari-dev/nebari-docs))? Link to PR:

## Testing

- [ ] Did you test the pull request locally?
- [ ] Did you add new tests?

### How to test

<!-- Steps to take to test the new feature, verify the bug is fixed, etc.
Please do not just include steps for the happy path, but failure modes too. -->

## Any other comments?

<!--
Expand Down