Thank you for your interest in contributing to chalk! There are many ways to contribute, and we appreciate all of them.
If you'd like to contribute, consider joining the Traits Working Group. We hang out on the rust-lang zulip in the #wg-traits stream.
As a reminder, all contributors are expected to follow our Code of Conduct.
While bugs are unfortunate, they're a reality in software. We can't fix what we don't know about, so please report liberally. If you're not sure if something is a bug or not, feel free to file a bug anyway.
If you have the chance, before reporting a bug, please search existing issues, as it's possible that someone else has already reported your error. This doesn't always work, and sometimes it's hard to know what to search for, so consider this extra credit. We won't mind if you accidentally file a duplicate report.
Sometimes, a backtrace is helpful, and so including that is nice. To get
a backtrace, set the RUST_BACKTRACE environment variable to a value
other than 0. The easiest way to do this is to invoke chalk like this:
$ RUST_BACKTRACE=1 chalk ...There is a repl mainly for debugging purposes which can be run by cargo run. Some basic examples are in libstd.chalk:
$ cargo run
?- load libstd.chalk
?- Vec<Box<i32>>: Clone
Unique; substitution [], lifetime constraints []More logging can be enabled by setting the CHALK_DEBUG environment variable. Set CHALK_DEBUG=1 to see info!(...) output, and CHALK_DEBUG=2 to see debug!(...) output as well.
Pull requests are the primary mechanism we use to change Rust. GitHub itself has some great documentation on using the Pull Request feature. We use the "fork and pull" model described here, where contributors push changes to their personal fork and create pull requests to bring those changes into the source repository.
Please make pull requests against the master branch.
Documentation improvements are very welcome. Documentation pull requests function in the same way as other pull requests.
You can find documentation style guidelines in RFC 1574.
There are several blog posts which describe the ideas and machinery inside of chalk.
In addition to the blog posts there is a glossary explaining some of the terminology used in chalk.
The rustc-dev-guide describes new-style trait solving, which is slowly replacing the old trait resolution.