Contributing.md

   1 ## Contributing
   2
   3 ### Test and file issues
   4
   5 It would be really useful to have people use rustfmt on their projects and file
   6 issues where it does something you don't expect.
   7
   8 A really useful thing to do that on a crate from the Rust repo. If it does
   9 something unexpected, file an issue; if not, make a PR to the Rust repo with the reformatted code. I hope to get the whole repo consistently rustfmt'ed and to
  10 replace `make tidy` with rustfmt as a medium-term goal.
  11
  12 ### Create test cases
  13
  14 Having a strong test suite for a tool like this is essential. It is very easy
  15 to create regressions. Any tests you can add are very much appreciated.
  16
  17 ### Hack!
  18
  19 Here are some [good starting issues](https://github.com/nrc/rustfmt/issues?q=is%3Aopen+is%3Aissue+label%3Aeasy).
  20 Note than some of those issues tagged 'easy' are not that easy and might be better
  21 second issues, rather than good first issues to fix.
  22
  23 If you've found areas which need polish and don't have issues, please submit a
  24 PR, don't feel there needs to be an issue.