Exclude more files in Cargo.toml

[RazrFalcon]

Exclusion of CHANGELOG.md, CONTRIBUTORS.md and README.md will decrease .crate file size from 186KiB to 133KiB.

[kbknapp]

Great catch, thanks @RazrFalcon! I actually started doing this in v3, but didn't backport it to v2.

If someone wants an easy PR this is a great one. If it hasn't been knocked out by the time I make the next merge I'll knock it out.

[kbknapp]

Slightly on a different note, I wonder if anyone has done any testing with removing all comments during cargo package, I'd imagine that'd save quite a bit community wide. Considering clap is nearly 45% comments (counting src/ dir only and only counting lines). And comment lines I'd imagine are far more dense than code.

kevin@beefcake: ~/Projects/clap-rs 
➜ tokei src
-------------------------------------------------------------------------------
 Language            Files        Lines         Code     Comments       Blanks
-------------------------------------------------------------------------------
 Rust                   40        19373        10852         7468         1053
-------------------------------------------------------------------------------
 Total                  40        19373        10852         7468         1053
-------------------------------------------------------------------------------

[kbknapp]

In my unscientific test, doing both more excludes (*.md) and removing all comments brings it down to 68K. I'd say that's decently substantial (basically 33% of the original size).

[kbknapp]

Hmm, actually excluding the README.md might be a bad idea. This is what is rendered on the crates.io package page :\

[kbknapp]

I'm not sure any more...partially because it's late, but also looking through the cargo and crates.io source, it looks like the readme may get uploaded separately...but to be safe we should ask someone from the cargo or crates.io team to confirm.

[RazrFalcon]

This is what is rendered on the crates.io package page

I thought that it uses github repo. My bad.

The problem with .crate files is that they can contain anything, but only src dir and Cargo.toml are important (afaiu). There are no official guidelines about it.

But if, for some reasons, original repo will disappear - this is the only way of retrieving the source code, so at least tests should still be present.

Have no idea what should be done in this case, but currently we just decreasing the bandwidth and bloating the .cargo dir (last time I've check it was 3GiB).

[kbknapp]

This has started on v3-master. I'm going to close this issue as I don't plan on backporting to v2 and any further work would need some official Rust guidelines on the matter.