File tree 2 files changed +31
-0
lines changed
2 files changed +31
-0
lines changed Original file line number Diff line number Diff line change
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.
Original file line number Diff line number Diff line change @@ -52,6 +52,9 @@ cargo:rerun-if-changed=/Users/yoda/projects/rust-lang/vergen/.git/refs/heads/fea
52
52
## Example Usage
53
53
See the documentation at [ docs.rs] ( https://docs.rs/vergen/3.2.0/vergen/#cargo-key-build-script-output ) for example usage
54
54
55
+ ## Contributing
56
+ See the documentation at [ CONTRIBUTING.md] ( CONTRIBUTING.md )
57
+
55
58
## License
56
59
57
60
Licensed under either of
You can’t perform that action at this time.
0 commit comments