You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 29, 2021. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-16Lines changed: 7 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,33 +2,21 @@ Thanks for wanting to contribute!
2
2
3
3
Feel free to create issues or make pull requests, we'll try to quickly review them.
4
4
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.
13
6
14
7
# Pull Requests
15
8
16
9
## Project Ideas
17
10
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!
20
13
21
14
## Best Practices
22
15
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.
24
17
25
18
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.
26
19
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
-
32
20
# Releasing
33
21
34
22
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
39
27
- Create a github release
40
28
- Identify what fixes, features, and breaking changes are in the release.
41
29
- Run `cargo publish` (run `cargo login` first if needed)
0 commit comments