Skip to content

Latest commit

 

History

History
135 lines (95 loc) · 5.2 KB

CONTRIBUTING.md

File metadata and controls

135 lines (95 loc) · 5.2 KB
Raw

Note that this Contribution.md document is more or less a copy of the file with the same name of the Rust compiler project.

Contributing to chalk

Thank you for your interest in contributing to chalk! There are many ways to contribute, and we appreciate all of them.

If you have questions, please join our gitter channel.

As a reminder, all contributors are expected to follow our Code of Conduct.

Feature Requests

To request a change to the way that the Rust language works, please open an issue in the RFCs repository rather than this one. New features and other significant language changes must go through the RFC process.

Bug Reports

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 ...

Building

Chalk has to be build with the nightly version of the rust compiler.

Pull Requests

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.

Writing Documentation

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.

Issue Triage

Sometimes, an issue will stay open, even though the bug has been fixed. And sometimes, the original bug may go stale because something has changed in the meantime.

It can be helpful to go through older bug reports and make sure that they are still valid. Load up an older issue, double check that it's still true, and leave a comment letting us know if it is or is not. The least recently updated sort is good for finding issues like this.

Contributors with sufficient permissions on the Rust repo can help by adding labels to triage issues:

  • Green, E-prefixed labels explain the level of experience necessary to fix the issue.

  • Red, I-prefixed labels indicate the importance of the issue. The I-nominated label indicates that an issue has been nominated for prioritizing at the next triage meeting.

  • The purple metabug label marks lists of bugs collected by other categories.

  • Orange, P-prefixed labels indicate a bug's priority. These labels are only assigned during triage meetings, and replace the I-nominated label.

  • The light orange relnotes label marks issues that should be documented in the release notes of the next release.

  • Gray, S-prefixed labels are used for tracking the status of pull requests.

If you're looking for somewhere to start, check out the E-easy tag.

Helpful Links and Information

Blog posts

There are several blog posts which describe the ideas and machinery inside of chalk.

Glossary

In addition to the blog posts there is a glossary explaining some of the terminology used in chalk.