Add a CONTRIBUTING.md file

CONTRIBUTING.md

@@ -0,0 +1,147 @@
+*Note that this `Contribution.md` document is more or less a copy of the file
+with the same name of the [Rust compiler](https://github.com/rust-lang/rust)
+project.*
+
+# Contributing to chalk
+
+Thank you for your interest in contributing to chalk! There are many ways to
+contribute, and we appreciate all of them.
+
+* [Feature Requests](#feature-requests)
+* [Bug Reports](#bug-reports)
+* [Pull Requests](#pull-requests)
+* [Writing Documentation](#writing-documentation)
+* [Issue Triage](#issue-triage)
+* [Helpful Links and Information](#helpful-links-and-information)
+
+If you have questions, please join [our gitter channel](https://gitter.im/chalk-rs/Lobby).
+
+As a reminder, all contributors are expected to follow our [Code of Conduct][coc].
+
+[pound-rust-internals]: https://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-internals
+[internals]: https://internals.rust-lang.org
+[coc]: https://www.rust-lang.org/conduct.html
+
+## Feature Requests
+[feature-requests]: #feature-requests
+
+To request a change to the way that the Rust language works, please open an
+issue in the [RFCs repository](https://github.com/rust-lang/rfcs/issues/new)
+rather than this one. New features and other significant language changes
+must go through the RFC process.
+
+## Bug Reports
+[bug-reports]: #bug-reports
+
+While bugs are unfortunate, they're a reality in software. We can't fix what we
+don't know about, so please report liberally. If you're not sure if something
+is a bug or not, feel free to file a bug anyway.
+
+If you have the chance, before reporting a bug, please search existing issues,
+as it's possible that someone else has already reported your error. This doesn't
+always work, and sometimes it's hard to know what to search for, so consider
+this extra credit. We won't mind if you accidentally file a duplicate report.
+
+Sometimes, a backtrace is helpful, and so including that is nice. To get
+a backtrace, set the `RUST_BACKTRACE` environment variable to a value
+other than `0`. The easiest way to do this is to invoke `chalk` like this:
+
+```bash
+$ RUST_BACKTRACE=1 chalk ...
+```
+
+### Building
+[building]: #building
+
+Chalk has to be build with the nightly version of the rust compiler.
+
+## Pull Requests
+[pull-requests]: #pull-requests
+
+Pull requests are the primary mechanism we use to change Rust. GitHub itself
+has some [great documentation][pull-requests] on using the Pull Request feature.
+We use the "fork and pull" model [described here][development-models], where
+contributors push changes to their personal fork and create pull requests to
+bring those changes into the source repository.
+
+[pull-requests]: https://help.github.com/articles/about-pull-requests/
+[development-models]: https://help.github.com/articles/about-collaborative-development-models/
+
+Please make pull requests against the `master` branch.
+
+## Writing Documentation
+[writing-documentation]: #writing-documentation
+
+Documentation improvements are very welcome. Documentation pull requests
+function in the same way as other pull requests.
+
+You can find documentation style guidelines in [RFC 1574][rfc1574].
+
+[rfc1574]: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text
+
+## Issue Triage
+[issue-triage]: #issue-triage
+
+Sometimes, an issue will stay open, even though the bug has been fixed. And
+sometimes, the original bug may go stale because something has changed in the
+meantime.
+
+It can be helpful to go through older bug reports and make sure that they are
+still valid. Load up an older issue, double check that it's still true, and
+leave a comment letting us know if it is or is not. The [least recently
+updated sort][lru] is good for finding issues like this.
+
+Contributors with sufficient permissions on the Rust repo can help by adding
+labels to triage issues:
+
+* Green, **E**-prefixed labels explain the level of **experience** necessary
+  to fix the issue.
+
+* Red, **I**-prefixed labels indicate the **importance** of the issue. The
+  [I-nominated][inom] label indicates that an issue has been nominated for
+  prioritizing at the next triage meeting.
+
+* The purple **metabug** label marks lists of bugs collected by other
+  categories.
+
+* Orange, **P**-prefixed labels indicate a bug's **priority**. These labels
+  are only assigned during triage meetings, and replace the [I-nominated][inom]
+  label.
+
+* The light orange **relnotes** label marks issues that should be documented in
+  the release notes of the next release.
+
+* Gray, **S**-prefixed labels are used for tracking the **status** of pull
+  requests.
+
+If you're looking for somewhere to start, check out the [E-easy][eeasy] tag.
+
+[inom]: https://github.com/rust-lang-nursery/chalk/issues?q=is%3Aopen+is%3Aissue+label%3AI-nominated
+[eeasy]: https://github.com/rust-lang-nursery/chalk/issues?q=is%3Aopen+is%3Aissue+label%3AE-easy
+[lru]: https://github.com/rust-lang-nursery/chalk/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-asc
+
+
+# Helpful Links and Information
+[Helpful Links and Information]: #helpful-links-and-information
+
+## Blog posts
+
+Here are some blog posts talking about chalk:
+
+- [Lowering Rust Traits to Logic](http://smallcultfollowing.com/babysteps/blog/2017/01/26/lowering-rust-traits-to-logic/)
+    - Explains the basic concepts at play
+- [Unification in Chalk, Part 1](http://smallcultfollowing.com/babysteps/blog/2017/03/25/unification-in-chalk-part-1/)
+    - An introduction to unification
+- [Unification in Chalk, Part 2](http://smallcultfollowing.com/babysteps/blog/2017/04/23/unification-in-chalk-part-2/)
+    - Extending the system for associated types
+- [Negative reasoning in Chalk](http://aturon.github.io/blog/2017/04/24/negative-chalk/)
+    - How to prove that something is not true
+- [Query structure in chalk](http://smallcultfollowing.com/babysteps/blog/2017/05/25/query-structure-in-chalk/)
+    - The basic chalk query structure, with pointers into the chalk implementation
+- [Cyclic queries in chalk](http://smallcultfollowing.com/babysteps/blog/2017/09/12/tabling-handling-cyclic-queries-in-chalk/)
+    - Handling cyclic relations and enabling the implementation of implied bounds and other long-desired features in an elegant way
+
+## Glossary
+
+In addition to the blog posts there is a [glossary](GLOSSARY.md) explaining some
+of the terminology used in chalk.

README.md

@@ -16,24 +16,6 @@ suitable reference.
 [Chalkidiki]: https://en.wikipedia.org/wiki/Chalkidiki
 [Aristotle]: https://en.wikipedia.org/wiki/Aristotle
 
-## Blog posts
-
-Here are some blog posts talking about chalk:
-
-- [Lowering Rust Traits to Logic](http://smallcultfollowing.com/babysteps/blog/2017/01/26/lowering-rust-traits-to-logic/)
-    - Explains the basic concepts at play
-- [Unification in Chalk, Part 1](http://smallcultfollowing.com/babysteps/blog/2017/03/25/unification-in-chalk-part-1/)
-    - An introduction to unification
-- [Unification in Chalk, Part 2](http://smallcultfollowing.com/babysteps/blog/2017/04/23/unification-in-chalk-part-2/)
-    - Extending the system for associated types
-- [Negative reasoning in Chalk](http://aturon.github.io/blog/2017/04/24/negative-chalk/)
-    - How to prove that something is not true
-- [Query structure in chalk](http://smallcultfollowing.com/babysteps/blog/2017/05/25/query-structure-in-chalk/)
-    - The basic chalk query structure, with pointers into the chalk implementation
-- [Cyclic queries in chalk](http://smallcultfollowing.com/babysteps/blog/2017/09/12/tabling-handling-cyclic-queries-in-chalk/)
-    - Handling cyclic relations and enabling the implementation of implied bounds and other long-desired features in an elegant way
-
-## Documentation
-
-In addition to the blog posts there is a [glossary](GLOSSARY.md) explaining some
-of the terminology used in *chalk*.
+## Contributing
+If you are interested in contributing to chalk, please take a look at the
+[Contribution guide](CONTRIBUTING.md).