Skip to content

Commit fe426b7

Browse files
committed
Add intro and mention IRC in CONTRIBUTING.md
This is partly taken from the [rustfmt CONTRIBUTING.md][contrib]. [contrib]: https://github.com/rust-lang-nursery/rustfmt/blob/master/Contributing.md
1 parent ae32137 commit fe426b7

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

CONTRIBUTING.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
Hello fellow Rustacean! Great to see your interest in compiler internals and lints!
44

5+
Clippy welcomes contributions from everyone. There are many ways to contribute to Clippy and the following document explains how
6+
you can contribute and how to get started.
7+
If you have any questions about contributing or need help with anything, feel free to ask questions on issues or
8+
visit the `#clippy` IRC channel on `irc.mozilla.org`.
9+
10+
All contributors are expected to follow the [Rust Code of Conduct](http://www.rust-lang.org/conduct.html).
11+
512
## Getting started
613

714
High level approach:
@@ -56,7 +63,7 @@ of this.
5663

5764
There is also the internal `author` lint to generate clippy code that detects the offending pattern. It does not work for all of the Rust syntax, but can give a good starting point.
5865

59-
Create a new UI test with the pattern you want to match:
66+
First, create a new UI test file in the `tests/ui/` directory with the pattern you want to match:
6067

6168
```rust
6269
// ./tests/ui/my_lint.rs
@@ -71,7 +78,7 @@ fn main() {
7178
```
7279

7380
Now you run `TESTNAME=ui/my_lint cargo test --test compile-test` to produce
74-
the file with the generated code:
81+
a `.stdout` file with the generated code:
7582

7683
```rust
7784
// ./tests/ui/my_lint.stdout
@@ -87,6 +94,8 @@ if_chain! {
8794
}
8895
```
8996

97+
If the command was executed successfully, you can copy the code over to where you are implementing your lint.
98+
9099
#### Documentation
91100

92101
Please document your lint with a doc comment akin to the following:
@@ -140,17 +149,10 @@ enabled as a plugin:
140149

141150
## Contributions
142151

143-
Clippy welcomes contributions from everyone.
144-
145152
Contributions to Clippy should be made in the form of GitHub pull requests. Each pull request will
146153
be reviewed by a core contributor (someone with permission to land patches) and either landed in the
147154
main tree or given feedback for changes that would be required.
148155

149156
All code in this repository is under the [Mozilla Public License, 2.0](https://www.mozilla.org/MPL/2.0/)
150157

151-
## Conduct
152-
153-
We follow the [Rust Code of Conduct](http://www.rust-lang.org/conduct.html).
154-
155-
156158
<!-- adapted from https://github.com/servo/servo/blob/master/CONTRIBUTING.md -->

0 commit comments

Comments
 (0)