Skip to content

Commit 2d81610

Browse files
authored
Create contributing.md (#48)
Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>
1 parent 5284f72 commit 2d81610

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

contributing.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## License
2+
3+
Licensed under either of
4+
5+
* Apache License, Version 2.0
6+
([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
7+
* MIT license
8+
([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
9+
10+
at your option.
11+
12+
## Contribution
13+
14+
Unless you explicitly state otherwise, any contribution intentionally submitted
15+
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
16+
dual licensed as above, without any additional terms or conditions.
17+
18+
### Run integration tests
19+
20+
Requires `docker` and [`cargo-hack`].
21+
22+
Check [getting Docker guide](https://docs.docker.com/get-docker/) on how to install docker,
23+
and use `cargo install cargo-hack` to install [`cargo-hack`].
24+
25+
```
26+
./run_ci_tests.sh
27+
```
28+
29+
It will create a container which runs sshd, set up an ssh-agent, and set environment variables
30+
that are required to run the integration tests.
31+
It will also test different combination of feature flags to ensure they all compile without error.
32+
33+
[`cargo-hack`]: https://github.com/taiki-e/cargo-hack

0 commit comments

Comments
 (0)