Skip to content

Improving CONTRIBUTING.md #2666

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
4 of 5 tasks
phansch opened this issue Apr 13, 2018 · 1 comment
Closed
4 of 5 tasks

Improving CONTRIBUTING.md #2666

phansch opened this issue Apr 13, 2018 · 1 comment
Labels
A-documentation Area: Adding or improving documentation good first issue These issues are a good way to get started with Clippy

Comments

@phansch
Copy link
Member

phansch commented Apr 13, 2018 •
edited
Loading

Currently the contribution guidelines are very high level. It would be nice if we explain in detail, how to make two of the most common contributions:

And some more minor things:

  • A table of contents as the file is getting bigger
  • Mention the #clippy IRC channel
  • Improve author lint instructions: (from IRC) "I was confused by the author lint stuff; do I just write the pattern down and run the compile-test?"
@phansch phansch added good first issue These issues are a good way to get started with Clippy A-documentation Area: Adding or improving documentation labels Apr 13, 2018
This was referenced Apr 13, 2018
Merged
Merged
This was referenced Apr 21, 2018
Merged
Merged
phansch added a commit to phansch/rust-clippy that referenced this issue Feb 11, 2019
@phansch
Document declare_clippy_lint macro
8003de2 
Split up from my work on updating CONTRIBUTING.md, which is slowly
making progress.

cc rust-lang#2666
@phansch phansch mentioned this issue Feb 11, 2019
Merged
phansch added a commit to phansch/rust-clippy that referenced this issue Feb 11, 2019
@phansch
Document declare_clippy_lint macro
a27022e 
Split up from my work on updating CONTRIBUTING.md, which is slowly
making progress.

cc rust-lang#2666
bors added a commit that referenced this issue Feb 11, 2019
@bors
Auto merge of #3758 - phansch:document_macro, r=flip1995
2066368 
Document `declare_clippy_lint` macro

Split up from my work on updating CONTRIBUTING.md, which is slowly
making progress.

cc #2666
@phansch
Copy link
Member Author

phansch commented Apr 26, 2020

I'm not sure if we really need to document how to fix a false positive. This very much depends on the specific bugs as well. There also seem to be no requests for help when it comes to fixing false positives, so I'm going to consider this issue as done.

I still think we can improve our contributing documentation, but I'd prefer more precise issues for doing that.

@phansch phansch closed this as completed Apr 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-documentation Area: Adding or improving documentation good first issue These issues are a good way to get started with Clippy
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Manishearth @phansch