Skip to content

Commit

Permalink
chore(github): Improve PR template "document later" checkbox descript…
Browse files Browse the repository at this point in the history
…ion (#4625)

# Description

## Problem\*

Describing the option as "Exceptional Case" wasn't very intuitive. Some
PRs that were meant to check that box checked the "No documentation
needed." box instead.

## Summary\*

Describe the option as "For Experimental Features" instead, as most if
not all such exceptional cases that docs were preferred to be delayed
came from features being still experimental (i.e. not intended for
public use yet).

## Documentation\*

Check one:
- [x] No documentation needed.
- [ ] Documentation included in this PR.
- [ ] **[Exceptional Case]** Documentation to be submitted in a separate
PR.

# PR Checklist\*

- [ ] I have tested the changes locally.
- [ ] I have formatted the changes with [Prettier](https://prettier.io/)
and/or `cargo fmt` on default settings.
  • Loading branch information
Savio-Sou authored Mar 25, 2024
1 parent ea3bb7f commit b62ecf5
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Resolves <!-- Link to GitHub Issue -->
Check one:
- [ ] No documentation needed.
- [ ] Documentation included in this PR.
- [ ] **[Exceptional Case]** Documentation to be submitted in a separate PR.
- [ ] **[For Experimental Features]** Documentation to be submitted in a separate PR.

# PR Checklist\*

Expand Down

0 comments on commit b62ecf5

Please sign in to comment.