Mirrors/nushell
2
0
Fork 0
mirror of https://github.com/nushell/nushell synced 2024-12-27 05:23:11 +00:00
Code Issues Projects Releases Packages Wiki Activity
nushell/.github/pull_request_template.md

41 lines
1.7 KiB
Markdown
Raw Normal View History

add a comment note to the PR template about linking issues (#9392) i see very often contributors mentionning an issue that their PR is supposed to solve without using the proper [*linking keywords* of *GitHub*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) :thinking: in this PR, i've added a little comment to the top of the PR template to hopefully explain how to achieve this automatically without requiring maintainers to link PRs manually :relieved:
2023-06-10 15:10:03 +00:00
<!--
if this PR closes one or more issues, you can automatically link the PR with
them by using one of the [*linking keywords*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword), e.g.
- this PR should close #xxxx
- fixes #xxxx
you can also mention related issues, PRs or discussions!
-->
Update PR template; Add some tests instructions (#7135)
2022-11-14 23:43:15 +00:00
Update pull_request_template.md
2022-01-24 19:01:03 +00:00
# Description
DEV: make all "comments" real md comments in the PR template (#8708) # Description i sometimes see some sections of the PR template being left untouched by contributors :thinking: this is not a big deal at all, but i thought we could hide them in the final PR by making the italic hints real markdown comments with the `<!-- ... -->` syntax. this has the effect of - still showing the guidelines to the contributor in the PR creation window - not show these guidelines in the visible PR body > **Warning** > limitations > - this won't remove the comments from the squashed commit when the PR lands :thinking: > - we might need to use a more structured template for this, like in the [feature requests](https://github.com/nushell/nushell/issues/new?assignees=&labels=enhancement&template=feature_request.yml) but i'm not sure this works with PR templates :confused: # User-Facing Changes ``` $nothing ``` # Tests + Formatting ``` $nothing ``` # After Submitting ``` $nothing ```
2023-04-12 17:30:12 +00:00
<!--
Thank you for improving Nushell. Please, check our [contributing guide](../CONTRIBUTING.md) and talk to the core team before making major changes.
Update pull_request_template.md
2022-01-24 19:01:03 +00:00
DEV: make all "comments" real md comments in the PR template (#8708) # Description i sometimes see some sections of the PR template being left untouched by contributors :thinking: this is not a big deal at all, but i thought we could hide them in the final PR by making the italic hints real markdown comments with the `<!-- ... -->` syntax. this has the effect of - still showing the guidelines to the contributor in the PR creation window - not show these guidelines in the visible PR body > **Warning** > limitations > - this won't remove the comments from the squashed commit when the PR lands :thinking: > - we might need to use a more structured template for this, like in the [feature requests](https://github.com/nushell/nushell/issues/new?assignees=&labels=enhancement&template=feature_request.yml) but i'm not sure this works with PR templates :confused: # User-Facing Changes ``` $nothing ``` # Tests + Formatting ``` $nothing ``` # After Submitting ``` $nothing ```
2023-04-12 17:30:12 +00:00
Description of your pull request goes here. **Provide examples and/or screenshots** if your changes affect the user experience.
-->
Update contributing guide and PR template (#7008) * Update contributing guide * Refactor pull request template * Reword PR template a bit * Update CONTRIBUTING.md Co-authored-by: Reilly Wood <26268125+rgwood@users.noreply.github.com> * Reformulate * Make "Before Submitting" a top-level header * Add review requirement to After Submitting * Reformulate * Update .github/pull_request_template.md Co-authored-by: Dan Davison <dandavison7@gmail.com> * Reformulate contributing guide Co-authored-by: Reilly Wood <26268125+rgwood@users.noreply.github.com> Co-authored-by: Dan Davison <dandavison7@gmail.com>
2022-11-07 21:57:29 +00:00
Update PR template; Add some tests instructions (#7135)
2022-11-14 23:43:15 +00:00
# User-Facing Changes
DEV: make all "comments" real md comments in the PR template (#8708) # Description i sometimes see some sections of the PR template being left untouched by contributors :thinking: this is not a big deal at all, but i thought we could hide them in the final PR by making the italic hints real markdown comments with the `<!-- ... -->` syntax. this has the effect of - still showing the guidelines to the contributor in the PR creation window - not show these guidelines in the visible PR body > **Warning** > limitations > - this won't remove the comments from the squashed commit when the PR lands :thinking: > - we might need to use a more structured template for this, like in the [feature requests](https://github.com/nushell/nushell/issues/new?assignees=&labels=enhancement&template=feature_request.yml) but i'm not sure this works with PR templates :confused: # User-Facing Changes ``` $nothing ``` # Tests + Formatting ``` $nothing ``` # After Submitting ``` $nothing ```
2023-04-12 17:30:12 +00:00
<!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. -->
Create pull_request_template.md
2022-01-24 18:58:09 +00:00
Update PR template; Add some tests instructions (#7135)
2022-11-14 23:43:15 +00:00
# Tests + Formatting
DEV: make all "comments" real md comments in the PR template (#8708) # Description i sometimes see some sections of the PR template being left untouched by contributors :thinking: this is not a big deal at all, but i thought we could hide them in the final PR by making the italic hints real markdown comments with the `<!-- ... -->` syntax. this has the effect of - still showing the guidelines to the contributor in the PR creation window - not show these guidelines in the visible PR body > **Warning** > limitations > - this won't remove the comments from the squashed commit when the PR lands :thinking: > - we might need to use a more structured template for this, like in the [feature requests](https://github.com/nushell/nushell/issues/new?assignees=&labels=enhancement&template=feature_request.yml) but i'm not sure this works with PR templates :confused: # User-Facing Changes ``` $nothing ``` # Tests + Formatting ``` $nothing ``` # After Submitting ``` $nothing ```
2023-04-12 17:30:12 +00:00
<!--
Update PR template; Add some tests instructions (#7135)
2022-11-14 23:43:15 +00:00
Don't forget to add tests that cover your changes.
Add test requirements to PR template (#5809) * Add test requirements to PR template * tweak words * another tweak * add /tests folder as a suggestion Co-authored-by: Darren Schroeder <343840+fdncred@users.noreply.github.com>
2022-06-16 13:14:59 +00:00
Create pull_request_template.md
2022-01-24 18:58:09 +00:00
Make sure you've run and fixed any issues with these commands:
Update PR template to mention user-facing changes (#6923) * Update PR template to mention user-facing changes * remove checkboxes
2022-10-28 16:14:08 +00:00
- `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes)
remove Clippy flags from the PR template (#10087) related to - https://github.com/nushell/nushell/pull/10072 - https://github.com/nushell/nushell/pull/10073 cc/ @sholderbach # Description i think the PR template was the missing place where a `cargo clippy` appears :smirk:
2023-08-21 17:45:48 +00:00
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used` to check that you're using the standard code style
Feature cleanup (#7182) Following up on #7180 with some feature cleanup: - Move the `database` feature from `plugin` to `default` - Rename the `database` feature to `sqlite` - Remove `--features=extra` from a lot of scripts etc. - No need to specify this, the `extra` feature is now the same as the default feature set - Remove the now-redundant 2nd Ubuntu test run
2022-11-23 00:58:11 +00:00
- `cargo test --workspace` to check that all tests pass
fix the `std` test commands calls in dev documents (#9535) related to a comment in https://github.com/nushell/nushell/pull/9500 > `cargo run -- crates/nu-std/tests/run.nu` Not done - doesn't seem to work this is absolutely true because the command in the PR template was obsolete... i've also updated the commands in the `CONTRIBUTING` document of the library :+1: cc/ @fnordpig
2023-07-12 16:26:47 +00:00
- `cargo run -- -c "use std testing; testing run-tests --path crates/nu-std"` to run the tests for the standard library
Add documentation requirement to PR template (#6749)
2022-10-16 15:19:54 +00:00
FEATURE: wrap the dev instructions from the PR template for easier use (#8152) i was writing #8148 and came to the "_Test + Formatting_" section of the PR template. i felt the developer instructions could be wrapped up in a common easy to use format, e.g. a `Makefile`, to be used with a few-words command only, e.g. `make fmt` or `make clippy`, instead of the long commands in the PR template :thinking: > **Note** > in case you guys do not want to add a `Makefile` to the `nushell` source, that PR can be discarded :relieved: # Description this PR - adds the few rules from the PR template to a new `Makefile` - replaces the instructions in the PR template from the full commands to the new `make` rules # User-Facing Changes - _none for the regular user_ - i believe easier to test PRs for the developer, allowing one not to realy on knowing the long commands or using the shell history to run them again :yum: # Tests + Formatting _nothing to test_ # After Submitting maybe mention that in `CONTRIBUTING.md`?
2023-03-11 18:10:32 +00:00
> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it automatically
> toolkit check pr
> ```
DEV: make all "comments" real md comments in the PR template (#8708) # Description i sometimes see some sections of the PR template being left untouched by contributors :thinking: this is not a big deal at all, but i thought we could hide them in the final PR by making the italic hints real markdown comments with the `<!-- ... -->` syntax. this has the effect of - still showing the guidelines to the contributor in the PR creation window - not show these guidelines in the visible PR body > **Warning** > limitations > - this won't remove the comments from the squashed commit when the PR lands :thinking: > - we might need to use a more structured template for this, like in the [feature requests](https://github.com/nushell/nushell/issues/new?assignees=&labels=enhancement&template=feature_request.yml) but i'm not sure this works with PR templates :confused: # User-Facing Changes ``` $nothing ``` # Tests + Formatting ``` $nothing ``` # After Submitting ``` $nothing ```
2023-04-12 17:30:12 +00:00
-->
FEATURE: wrap the dev instructions from the PR template for easier use (#8152) i was writing #8148 and came to the "_Test + Formatting_" section of the PR template. i felt the developer instructions could be wrapped up in a common easy to use format, e.g. a `Makefile`, to be used with a few-words command only, e.g. `make fmt` or `make clippy`, instead of the long commands in the PR template :thinking: > **Note** > in case you guys do not want to add a `Makefile` to the `nushell` source, that PR can be discarded :relieved: # Description this PR - adds the few rules from the PR template to a new `Makefile` - replaces the instructions in the PR template from the full commands to the new `make` rules # User-Facing Changes - _none for the regular user_ - i believe easier to test PRs for the developer, allowing one not to realy on knowing the long commands or using the shell history to run them again :yum: # Tests + Formatting _nothing to test_ # After Submitting maybe mention that in `CONTRIBUTING.md`?
2023-03-11 18:10:32 +00:00
Update contributing guide and PR template (#7008) * Update contributing guide * Refactor pull request template * Reword PR template a bit * Update CONTRIBUTING.md Co-authored-by: Reilly Wood <26268125+rgwood@users.noreply.github.com> * Reformulate * Make "Before Submitting" a top-level header * Add review requirement to After Submitting * Reformulate * Update .github/pull_request_template.md Co-authored-by: Dan Davison <dandavison7@gmail.com> * Reformulate contributing guide Co-authored-by: Reilly Wood <26268125+rgwood@users.noreply.github.com> Co-authored-by: Dan Davison <dandavison7@gmail.com>
2022-11-07 21:57:29 +00:00
# After Submitting
DEV: make all "comments" real md comments in the PR template (#8708) # Description i sometimes see some sections of the PR template being left untouched by contributors :thinking: this is not a big deal at all, but i thought we could hide them in the final PR by making the italic hints real markdown comments with the `<!-- ... -->` syntax. this has the effect of - still showing the guidelines to the contributor in the PR creation window - not show these guidelines in the visible PR body > **Warning** > limitations > - this won't remove the comments from the squashed commit when the PR lands :thinking: > - we might need to use a more structured template for this, like in the [feature requests](https://github.com/nushell/nushell/issues/new?assignees=&labels=enhancement&template=feature_request.yml) but i'm not sure this works with PR templates :confused: # User-Facing Changes ``` $nothing ``` # Tests + Formatting ``` $nothing ``` # After Submitting ``` $nothing ```
2023-04-12 17:30:12 +00:00
<!-- If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date. -->
Reference in a new issue Copy permalink