extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2024-11-22 08:23:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update PR template; Add some tests instructions (#7135)

Browse Source
This commit is contained in:
Jakub Žádník 2022-11-15 00:43:15 +01:00 committed by GitHub
parent 81b12d02ec
commit a783a084d4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
.github/pull_request_template.md vendored
View File

@ -1,19 +1,17 @@
# Description # Description
(Description of your pull request goes here. **Provide examples and/or screenshots** if your changes affect the user experience.) _(Thank you for improving Nushell. Please, check our [contributing guide](../CONTRIBUTING.md) and talk to the core team before making major changes.)_
# Major Changes _(Description of your pull request goes here. **Provide examples and/or screenshots** if your changes affect the user experience.)_
If you're considering making any major change to nushell, before starting work on it, seek feedback from regular contributors and get approval for the idea from the core team either on [Discord](https://discordapp.com/invite/NtAbbGn) or [GitHub issue](https://github.com/nushell/nushell/issues/new/choose). # User-Facing Changes
Making sure we're all on board with the change saves everybody's time.
Thanks! _(List of all changes that impact the user experience here. This helps us keep track of breaking changes.)_
# Tests + Formatting # Tests + Formatting
Make sure you've done the following, if applicable: Don't forget to add tests that cover your changes.
- 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: Make sure you've run and fixed any issues with these commands:
@ -23,4 +21,4 @@ Make sure you've run and fixed any issues with these commands:
# After Submitting # After Submitting
* Help us keep the docs up to date: If your PR affects the user experience of Nushell (adding/removing a command, changing an input/output type, etc.), make sure the changes are reflected in the documentation (https://github.com/nushell/nushell.github.io) after the PR is merged. 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.

12
CONTRIBUTING.md
View File

@ -31,6 +31,18 @@ cd nushell
cargo build cargo build
``` ```
### Tests
It is a good practice to cover your changes with a test. Also, try to think about corner cases and various ways how your changes could break. Cover those in the tests as well.
Tests can be found in different places:
* `/tests`
* `src/tests`
* command examples
* crate-specific tests
The most comprehensive test suite we have is the `nu-test-support` crate. For testing specific features, such as running Nushell in a REPL mode, we have so called "testbins". For simple tests, you can find `run_test()` and `fail_test()` functions.
### Useful Commands ### Useful Commands
- Build and run Nushell: - Build and run Nushell: