Skip to content

Commit 0f5520a

Browse files
Added CONTRIBUTING.md (#44)
* Added CONTRIBUTING.md * Added link to CONTRIBUTING.md Co-authored-by: Jason Ozias <[email protected]>
1 parent d10481d commit 0f5520a

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

CONTRIBUTING.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing to vergen
2+
1. Ensure you have `cargo-clippy` and `rustfmt` installed. These can be installed via rustup if you don't already have them.
3+
1. Fork the repository
4+
1. Run the following to clone and setup the repository. There are submodules in the testdata directory used for testing specific git scenarios
5+
6+
```
7+
git clone [email protected]:<your fork>/vergen.git
8+
cd vergen.git
9+
git submodule update --init
10+
```
11+
12+
1. Install `cargo-all-features`
13+
14+
```
15+
cargo install cargo-all-features
16+
```
17+
18+
1. Make your changes
19+
1. Before submitting a PR, make sure you have at least run the following
20+
21+
```
22+
cargo fmt
23+
cargo clippy --all
24+
cargo build-all-features
25+
cargo test-all-features
26+
```
27+
28+
1. Push your changes to your fork and submit a PR.

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,9 @@ cargo:rerun-if-changed=/Users/yoda/projects/rust-lang/vergen/.git/refs/heads/fea
5252
## Example Usage
5353
See the documentation at [docs.rs](https://docs.rs/vergen/3.2.0/vergen/#cargo-key-build-script-output) for example usage
5454

55+
## Contributing
56+
See the documentation at [CONTRIBUTING.md](CONTRIBUTING.md)
57+
5558
## License
5659

5760
Licensed under either of

0 commit comments

Comments
 (0)