X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=Contributing.md;h=9478bc89f3ba27b1906b20015b7ea238f31904a0;hb=01c14a2058924390543f072aeb5955a8d179df36;hp=3b6bf50adc18957e1bee93d5c0a6bc3344243584;hpb=802df67c2fc9166bb3542bb4cc3aefab42236ffe;p=rust.git diff --git a/Contributing.md b/Contributing.md index 3b6bf50adc1..9478bc89f3b 100644 --- a/Contributing.md +++ b/Contributing.md @@ -2,10 +2,12 @@ There are many ways to contribute to Rustfmt. This document lays out what they are and has information for how to get started. If you have any questions about -contributing or need help with anything, please ping nrc on irc, #rust-tools is -probably the best channel. Feel free to also ask questions on issues, or file -new issues specifically to get help. +contributing or need help with anything, please ping nrc on irc, #rust-dev-tools +on irc.mozilla.org is probably the best channel. Feel free to also ask questions +on issues, or file new issues specifically to get help. +All contributors are expected to follow our [Code of +Conduct](CODE_OF_CONDUCT.md). ## Test and file issues @@ -65,7 +67,7 @@ example, the `issue-1111.rs` test file is configured by the file ## Hack! -Here are some [good starting issues](https://github.com/rust-lang-nursery/rustfmt/issues?q=is%3Aopen+is%3Aissue+label%3Aeasy). +Here are some [good starting issues](https://github.com/rust-lang-nursery/rustfmt/issues?q=is%3Aopen+is%3Aissue+label%3Agood-first-issue). If you've found areas which need polish and don't have issues, please submit a PR, don't feel there needs to be an issue. @@ -106,7 +108,7 @@ format. There are different nodes for every kind of item and expression in Rust. For more details see the source code in the compiler - [ast.rs](https://dxr.mozilla.org/rust/source/src/libsyntax/ast.rs) - and/or the -[docs](http://manishearth.github.io/rust-internals-docs/syntax/ast/index.html). +[docs](https://doc.rust-lang.org/nightly/nightly-rustc/syntax/ast/index.html). Many nodes in the AST (but not all, annoyingly) have a `Span`. A `Span` is a range in the source code, it can easily be converted to a snippet of source @@ -203,7 +205,7 @@ and `ListFormatting` the key structure for configuration. You'll need to make a Rustfmt strives to be highly configurable. Often the first part of a patch is creating a configuration option for the feature you are implementing. All -handling of configuration options is done in [src/config.rs](src/config.rs). Look for the +handling of configuration options is done in [src/config/mod.rs](src/config/mod.rs). Look for the `create_config!` macro at the end of the file for all the options. The rest of the file defines a bunch of enums used for options, and the machinery to produce the config struct and parse a config file, etc. Checking an option is done by