yggdrasil/cbindgen
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Replace Travis CI references and update some formatting

Browse Source
This commit is contained in:
Alex Touchet 2023-01-30 23:24:56 -08:00 committed by Emilio Cobos Álvarez
parent b6e73017e6
commit 55e24c5090
2 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Cargo.toml
View File

@ -11,20 +11,17 @@ license = "MPL-2.0"
description = "A tool for generating C bindings to Rust code." description = "A tool for generating C bindings to Rust code."
keywords = ["bindings", "ffi", "code-generation"] keywords = ["bindings", "ffi", "code-generation"]
categories = ["external-ffi-bindings", "development-tools::ffi"] categories = ["external-ffi-bindings", "development-tools::ffi"]
repository = "https://github.com/eqrion/cbindgen/" repository = "https://github.com/eqrion/cbindgen"
edition = "2018" edition = "2018"
exclude = [ exclude = [
"tests/profile.rs", # Test relies in a sub-crate, see https://github.com/rust-lang/cargo/issues/9017 "tests/profile.rs", # Test relies in a sub-crate, see https://github.com/rust-lang/cargo/issues/9017
] ]
[badges]
travis-ci = { repository = "eqrion/cbindgen" }
[dependencies] [dependencies]
clap = { version = "3.1", optional = true } clap = { version = "3.1", optional = true }
indexmap = "1" indexmap = "1"
log = "0.4" log = "0.4"
serde = { version = "1.0.103", default-features = false, features = ["derive"]} serde = { version = "1.0.103", default-features = false, features = ["derive"] }
serde_json = "1.0" serde_json = "1.0"
tempfile = "3.0" tempfile = "3.0"
toml = "0.5" toml = "0.5"

8
contributing.md
View File

@ -2,23 +2,23 @@
Thanks for wanting to contribute! Thanks for wanting to contribute!
If you want help or mentorship, please file a Github issue and I'll be sure to provide guidance to the best of my ability. If you want help or mentorship, please file a GitHub issue and I'll be sure to provide guidance to the best of my ability.
Otherwise be sure to check out `internals.md` for an overview on the internals. Otherwise be sure to check out `internals.md` for an overview on the internals.
## Filing a pull request ## Filing a pull request
Check out [Servo's Github workflow](https://github.com/servo/servo/wiki/Github-workflow) for an overview on creating a pull request. Check out [Servo's GitHub workflow](https://github.com/servo/servo/wiki/Github-workflow) for an overview on creating a pull request.
Don't worry about requesting code review, as there is nothing formally setup for this repository. I try and review each pull request as soon as I can. Don't worry about requesting code review, as there is nothing formally setup for this repository. I try and review each pull request as soon as I can.
There is continuous integration setup for `cbindgen` using [travis](https://travis-ci.org/). It automatically runs `cargo test` which runs `cbindgen` against a series of rust files from `tests/rust/` and checks that the output compiles using `gcc` or `g++`. There is continuous integration setup for `cbindgen` using [GitHub Actions](https://github.com/eqrion/cbindgen/actions). It automatically runs `cargo test` which runs `cbindgen` against a series of Rust files from `tests/rust/` and checks that the output compiles using `gcc` or `g++`.
In addition to a C/C++ compiler `cargo test` requires Python and Cython In addition to a C/C++ compiler `cargo test` requires Python and Cython
(`python -m pip install Cython`) for checking Cython bindings generated from tests (`.pyx` files). (`python -m pip install Cython`) for checking Cython bindings generated from tests (`.pyx` files).
Please run `cargo test` before filing a pull request to be sure that all tests pass. This will also update the test expectations. Please run `cargo test` before filing a pull request to be sure that all tests pass. This will also update the test expectations.
Rustfmt is also enforced by travis. To format your code install `rustfmt-preview` using `rustup component add rustfmt-preview` and then `cargo fmt`. Travis runs with rust nightly, so use `rustup run nightly -- cargo fmt` to guarantee consistent results. Rustfmt is also enforced by GitHub Actions. To format your code install `rustfmt-preview` using `rustup component add rustfmt-preview` and then `cargo fmt`. GitHub Actions runs with Rust nightly, so use `rustup run nightly -- cargo fmt` to guarantee consistent results.
Writing new tests with your pull requests is also appreciated. Writing new tests with your pull requests is also appreciated.