Skip to content
This repository was archived by the owner on Dec 29, 2021. It is now read-only.

Commit 91682da

Browse files
committed
docs: Cleanup according to recommended style
1 parent ed55583 commit 91682da

File tree

5 files changed

+28
-22
lines changed

5 files changed

+28
-22
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
assert_cli version
2+
rust version
3+
OS and version

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
- [ ] Tests created for any new feature or regression tests for bugfixes.
2+
- [ ] `cargo test` succeeds
3+
- [ ] `cargo +nightly clippy` succeeds
4+
- [ ] `cargo +nightly fmt -- --write-mode=diff` succeeds

CONTRIBUTING.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,21 @@ Thanks for wanting to contribute!
22

33
Feel free to create issues or make pull requests, we'll try to quickly review them.
44

5-
If you need to reach out to us, find a relevant [issue](https://github.com/killercup/assert_cli/issues) or open a new one.
6-
7-
# Issues
8-
9-
Some helpful pieces of information when reporting issues
10-
* assert_cli version
11-
* rust version
12-
* OS and version
5+
If you need to reach out to us, find a relevant [issue][Issues] or open a new one.
136

147
# Pull Requests
158

169
## Project Ideas
1710

18-
If you're looking for things to do check out the [open issues](https://github.com/killercup`/assert_cli/issues).
19-
Or take a grep through [all TODO comments](https://github.com/killercup/assert_cli/search?q=TODO) in the code and feel free to help us out there!
11+
If you're looking for things to do check out the [open issues][Issues].
12+
Or take a grep through [all TODO comments][TODO] in the code and feel free to help us out there!
2013

2114
## Best Practices
2215

23-
We appreciate your help as-is. We'd love to help you through the process for contributing. We have some suggestions to help make things go more smoothly.
16+
We appreciate your help as-is. We'd love to help you through the process for contributing. We have some suggestions to help make things go more smoothly.
2417

2518
Before spending too much time on a PR, consider opening an issue so we can make sure we're aligned on how the problem should be solved.
2619

27-
🌈 **Here's a checklist for the perfect pull request:**
28-
- [ ] Make sure existing tests still work by running `cargo test` locally.
29-
- [ ] Add new tests for any new feature or regression tests for bugfixes.
30-
- [ ] Install [Clippy](https://github.com/Manishearth/rust-clippy) and run `rustup run nightly cargo clippy` to catch common mistakes (will be checked by Travis)
31-
3220
# Releasing
3321

3422
When we're ready to release, a project owner should do the following
@@ -39,3 +27,6 @@ When we're ready to release, a project owner should do the following
3927
- Create a github release
4028
- Identify what fixes, features, and breaking changes are in the release.
4129
- Run `cargo publish` (run `cargo login` first if needed)
30+
31+
[Issues]: https://github.com/killercup/assert_cli/issues
32+
[TODO]: https://github.com/killercup/assert_cli/search?q=TODO

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ homepage = "https://github.com/killercup/assert_cli"
99
documentation = "http://docs.rs/assert_cli/"
1010
readme = "README.md"
1111
categories = ["development-tools::testing"]
12-
keywords = ["cli", "testing", "assert", "command", "line"]
12+
keywords = ["cli", "testing", "assert", "command-line-interface"]
1313
build = "build.rs"
1414

1515
[[bin]]

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,14 @@
22

33
> **Test CLI Applications** - This crate checks the output of a child process is as expected.
44
5-
[![Build Status](https://travis-ci.org/killercup/assert_cli.svg)](https://travis-ci.org/killercup/assert_cli) [![Documentation](https://img.shields.io/badge/docs-master-blue.svg)][Documentation] ![License](https://img.shields.io/crates/l/assert_cli.svg) [![crates.io](https://img.shields.io/crates/v/assert_cli.svg)](https://crates.io/crates/assert_cli)
5+
[![Build Status](https://travis-ci.org/killercup/assert_cli.svg)][Travis]
6+
[![Documentation](https://img.shields.io/badge/docs-master-blue.svg)][Documentation]
7+
![License](https://img.shields.io/crates/l/assert_cli.svg)
8+
[![crates.io](https://img.shields.io/crates/v/assert_cli.svg)][Crates.io]
69

710
## Install
811

9-
For your tests, just add it to your `Cargo.toml`:
12+
For your tests, add it to your `Cargo.toml`:
1013

1114
```toml
1215
[dev-dependencies]
@@ -71,9 +74,9 @@ More detailed information is available in the [documentation]. :-)
7174
## Relevant crates
7275

7376
Other crates that might be useful in testing command line programs.
74-
* [dir-diff](https://crates.io/crates/dir-diff) for testing file side-effects.
75-
* [tempdir](https://crates.io/crates/tempdir) for scratchpad directories.
76-
* [duct](https://crates.io/crates/duct) for orchestrating multiple processes.
77+
* [dir-diff][dir-diff] for testing file side-effects.
78+
* [tempdir][tempdir] for scratchpad directories.
79+
* [duct][duct] for orchestrating multiple processes.
7780

7881
## License
7982

@@ -91,5 +94,10 @@ submitted for inclusion in the work by you, as defined in the Apache-2.0
9194
license, shall be dual licensed as above, without any additional terms or
9295
conditions.
9396

97+
[Travis]: https://travis-ci.org/killercup/assert_cli
98+
[Crates.io]: https://crates.io/crates/assert_cli
9499
[Documentation]: https://docs.rs/assert_cli
95100
[Environment]: https://github.com/Freyskeyd/environment
101+
[dir-diff]: https://crates.io/crates/dir-diff
102+
[tempdir]: https://crates.io/crates/tempdir
103+
[duct]: https://crates.io/crates/duct

0 commit comments

Comments
 (0)