From b56e603c583def6dc6d9c82378118f25868abd45 Mon Sep 17 00:00:00 2001 From: Reilly Wood <26268125+rgwood@users.noreply.github.com> Date: Fri, 28 Oct 2022 09:14:08 -0700 Subject: [PATCH] Update PR template to mention user-facing changes (#6923) * Update PR template to mention user-facing changes * remove checkboxes --- .github/pull_request_template.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 0284634a03..633424dda8 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,21 +1,23 @@ # Description -(description of your pull request here) +(Description of your pull request goes here. **Provide examples and/or screenshots** unless the change is trivial) -# Tests +# Tests + Formatting -Make sure you've done the following: +Make sure you've done the following, if applicable: -- [ ] Add tests that cover your changes, either in the command examples, the crate/tests folder, or in the /tests folder. -- [ ] Try to think about corner cases and various ways how your changes could break. Cover them with tests. -- [ ] If adding tests is not possible, please document in the PR body a minimal example with steps on how to reproduce so one can verify your change works. +- Add tests that cover your changes (either in the command examples, the crate/tests folder, or in the /tests folder) + - Try to think about corner cases and various ways how your changes could break. Cover those in the tests Make sure you've run and fixed any issues with these commands: -- [ ] `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) -- [ ] `cargo clippy --workspace --features=extra -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect` to check that you're using the standard code style -- [ ] `cargo test --workspace --features=extra` to check that all the tests pass +- `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) +- `cargo clippy --workspace --features=extra -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect` to check that you're using the standard code style +- `cargo test --workspace --features=extra` to check that all tests pass -# Documentation +# User-Facing Changes -- [ ] If your PR touches a user-facing nushell feature then make sure that there is an entry in the documentation (https://github.com/nushell/nushell.github.io) for the feature, and update it if necessary. +If you're making changes that will affect the user experience of Nushell (ex: adding/removing a command, changing an input/output type, adding a new flag): + +- Get another regular contributor to review the PR before merging +- Make sure that there is an entry in the documentation (https://github.com/nushell/nushell.github.io) for the feature, and update it if necessary