From c2cbcdd0dbeae699d539706d767790b6d7323973 Mon Sep 17 00:00:00 2001 From: chencheng Date: Fri, 25 Jul 2014 23:55:06 +0800 Subject: [PATCH] add CONTRIBUTING.md --- CONTRIBUTING.md | 15 +++++++++++++++ README.md | 2 +- 2 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..229aad4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# Contribution Guidelines + +Please ensure your pull request adheres to the following guidelines: + +- Search previous suggestions before making a new one, as yours may be a duplicate. +- Suggested packages should be tested and documented. +- Make an individual pull request for each suggestion. +- Use the following format: `[PACKAGE](LINK) - DESCRIPTION.` +- New categories, or improvements to the existing categorization are welcome. +- Keep descriptions short and simple, but descriptive. +- End all descriptions with a full stop/period. +- Check your spelling and grammar. +- Make sure your text editor is set to remove trailing whitespace. + +Thank you for your suggestions! diff --git a/README.md b/README.md index 200d5a7..76c90cf 100644 --- a/README.md +++ b/README.md @@ -485,4 +485,4 @@ Besides libraries, there're [Collection on Codepen](http://codepen.io/collection # Contributing -Your contributions are always welcome! +Contributions welcome! Read the [contribution guidelines](CONTRIBUTING.md) first.