From e541f5c8d80b51b6cdf36e86c733d9c9c2e5d3b9 Mon Sep 17 00:00:00 2001 From: Joe Block Date: Sat, 24 Dec 2016 07:54:19 -0700 Subject: [PATCH] Update PR guidelines in Contributing.md --- Contributing.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Contributing.md b/Contributing.md index ed90b95..6a99e44 100644 --- a/Contributing.md +++ b/Contributing.md @@ -7,13 +7,15 @@ First and foremost, thanks for the help, I appreciate all of the contributions, ### Submit a pull request. * Descriptions should be clear, concise, and non-promotional. +* The list is split into sections for frameworks, plugins, themes and completions, please add your entries to the appropriate sections. If an entry is a plugin that provides both plugin functionality and tab completions, add it to the plugins section. The completions section is meant for things that only provide extra tab completions. * Descriptions should follow the link, on the same line, with capitalization consistent with the other entries in the section. * Each entry should be a single line. This makes keeping the sections sorted easier. We let the GitHub formatter handle adding any required line breaks rather than embedding breaks in the lines ourselves. * Each entry should be limited to one link, and that link should be the first part of the line. It is ok to submit more than one entry in a PR. * If you're submitting a theme, please try to make sure that the theme repo has a screen shot so that list users can tell what it looks like before installing it. * Please make sure all framework, plugin, themes or completions list entries are sorted *alphabetically*. -* The link should be the name of the package or project -* Your PR should pass the travis checks. +* The link should be named the name of the package or project. +* Your PR should pass the Travis checks. If the travis checks show an error that you didn't add (a previous plugin entry has gone 404, for example) you don't _have_ to fix those errors, though I'll appreciate the help if you do. +* It is fine to have multiple new entries in a single PR ## To remove an entry: