Permalink
Browse files

Provide a brief overview in the README

A more conventional use of the README now that the guidelines are in
CONTRIBUTING.md.
  • Loading branch information...
1 parent d23af60 commit 7ffa65d8ab89cf8258f7c100086974fce2c0cabe @necolas committed Mar 17, 2013
Showing with 21 additions and 0 deletions.
  1. +21 −0 README.md
View
@@ -0,0 +1,21 @@
+# Issue guidelines
+
+This repository's [CONTRIBUTING.md](CONTRIBUTING.md) provides a generic set of
+guidelines for developers to adapt and include in their own GitHub
+repositories, thereby taking advantage of [GitHub's integration with
+contributing guidelines](https://github.com/blog/1184-contributing-guidelines).
+
+The section below can be included in your README to improve the visibility of
+your contribution guidelines.
+
+If you think this guide can be improved, please let me know.
+
+
+## Contributing to this project
+
+Anyone and everyone is welcome to contribute. Please take a moment to
+review the [guidelines for contributing](CONTRIBUTING.md).
+
+* [Bug reports](CONTRIBUTING.md#bugs)
+* [Feature requests](CONTRIBUTING.md#features)
+* [Pull requests](CONTRIBUTING.md#pull-requests)

0 comments on commit 7ffa65d

Please sign in to comment.