Merge pull request #3 from brson/contributing

Contributing

Author: branderson

CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# Contributing to the Rust Cookbook
+
+Have something useful to add to the Rust Cookbook? We'd love to have it!
+
+This document contains information and guidelines that you should read before 
+contributing to the project. If you think something in this document should change,
+feel free propose a change in a pull request.
+
+## Table of Contents
+* [Getting Started](#getting-started)  
+* [How to Contribute](#how-to-contribute)  
+* [Crates](#crates)  
+* [Tests](#tests)  
+* [Style](#style)
+    * [Git Commit Messages](#git-commit-messages)  
+    * [Snippet Style](#snippet-style)  
+
+## Getting Started
+TODO: Mention Trello and how to join (if we keep using it)
+
+## How to Contribute
+TODO: Reporting bugs  
+TODO: Project page suggestions  
+TODO: Fixing bugs  
+TODO: Pull requests  
+
+## Crates
+TODO: How to add new crates to project
+
+## Tests
+TODO: Write about writing tests
+
+## Style
+### Git Commit Messages
+https://chris.beams.io/posts/git-commit/  
+TODO: Possibly take relevant parts from this post or write our own
+
+### Snippet Style
+TODO: Talk about writing good idiomatic code  
+TODO: Maybe provide a template?

README.md

@@ -51,6 +51,8 @@ makes the `?` operator work
 
 For more background on error handling in Rust, read [this page of the Rust book][error-docs] and [this blog post][error-blog].
 
+## Contributing
+If you'd like to make changes to the project, please see [this guide](CONTRIBUTING.md).
 
 ## License
 
@@ -59,7 +61,7 @@ MIT/Apache-2.0
 
 <!-- Links -->
 
-[byteorder-badge]: https://img.shields.io/crates/v/rustc-serialize.svg
+[byteorder-badge]: https://img.shields.io/crates/v/rustc-serialize.svg?label=byteorder
 [byteorder]: https://docs.rs/byteorder
 [error-docs]: https://doc.rust-lang.org/book/error-handling.html 
 [error-blog]: https://brson.github.io/2016/11/30/starting-with-error-chain

pages/byteorder.md

@@ -53,5 +53,5 @@ fn main() { run().unwrap() }
 
 <!-- Links -->
 
-[byteorder-badge]: https://img.shields.io/crates/v/rustc-serialize.svg
+[byteorder-badge]: https://img.shields.io/crates/v/rustc-serialize.svg?label=byteorder
 [byteorder]: https://docs.rs/byteorder