Skip to content

Commit 1c743d5

Browse files
authored
docs: update CONTRIBUTING.md and README.md (starship#5153)
1 parent d07a8e3 commit 1c743d5

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ If you have any questions that aren't addressed in this document, please don't h
1010

1111
- **Module**: A component in the prompt giving information based on contextual information from your OS. For example, the `rust` module shows the version of Rust that is currently installed on your computer, if your current directory is a Rust project.
1212

13-
- **Segment**: Smaller sub-components that compose a module. For example, the `symbol` segment in the `rust` module contains the character that is shown before the version number (`🦀` by default).
13+
- **Segment**: Smaller subcomponents that compose a module. For example, the `symbol` segment in the `rust` module contains the character that is shown before the version number (`🦀` by default).
1414

1515
## Philosophy
1616

@@ -50,7 +50,7 @@ pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> {
5050

5151
## External commands
5252

53-
To run a external command (e.g. to get the version of a tool) and to allow for mocking use the `context.exec_cmd` function. Here's a quick example:
53+
To run an external command (e.g. to get the version of a tool) and to allow for mocking use the `context.exec_cmd` function. Here's a quick example:
5454

5555
```rust
5656
use super::{Context, Module, ModuleConfig};
@@ -127,7 +127,7 @@ STARSHIP_LOG=trace cargo run
127127

128128
## Linting
129129

130-
Starship source files are linted with [clippy](https://crates.io/crates/clippy). Clippy will be ran as part of CI. Linting errors will fail a build, so it is suggested that you run Clippy locally:
130+
Starship source files are linted with [clippy](https://crates.io/crates/clippy). Clippy will be run as part of CI. Linting errors will fail a build, so it is suggested that you run Clippy locally:
131131

132132
```sh
133133
rustup component add clippy
@@ -218,7 +218,7 @@ mod tests {
218218
}
219219
```
220220

221-
If a module depends on output of another program, then that output should be added to the match statement in [`utils.rs`](src/utils.rs). The match has to be exactly the same as the call to `utils::exec_cmd()`, including positional arguments and flags. The array of arguments are joined by a `" "`, so `utils::exec_cmd("program", &["arg", "more_args"])` would match with the `program arg more_args` match statement.
221+
If a module depends on output of another program, then that output should be added to the match statement in [`utils.rs`](src/utils.rs). The match has to be exactly the same as the call to `utils::exec_cmd()`, including positional arguments and flags. The array of arguments is joined by a `" "`, so `utils::exec_cmd("program", &["arg", "more_args"])` would match with the `program arg more_args` match statement.
222222

223223
If the program cannot be mocked (e.g. It performs some filesystem operations, either writing or reading files) then it has to added to the project's GitHub Actions workflow file([`.github/workflows/workflow.yml`](.github/workflows/workflow.yml)) and the test has to be marked with an `#[ignored]`. This ensures that anyone can run the test suite locally without needing to pre-configure their environment. The `#[ignored]` attribute is bypassed during CI runs in GitHub Actions.
224224

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ Install Starship using any of the following package managers:
271271

272272
</details>
273273

274-
### Step 2. Setup your shell to use Starship
274+
### Step 2. Set up your shell to use Starship
275275

276276
Configure your shell to initialize starship. Select yours from the list below:
277277

0 commit comments

Comments
 (0)