summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDan Reif <dan.reif@collectivehealth.com>2018-04-30 12:55:50 -0700
committerDan Reif <dan.reif@collectivehealth.com>2018-04-30 12:55:50 -0700
commit9f13bb7354a29dda5ca2cd149baa6bb7dab3dd14 (patch)
tree5b5193d84b63720221197942361dacce1b198073
parent7408b2a34a4e18faca7d1a8a2207933b47e64450 (diff)
downloadvim-polyglot-9f13bb7354a29dda5ca2cd149baa6bb7dab3dd14.tar.gz
vim-polyglot-9f13bb7354a29dda5ca2cd149baa6bb7dab3dd14.zip
Update README with slightly more verbose contribution guidelines
-rw-r--r--README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.md b/README.md
index 02c8d208..839424bc 100644
--- a/README.md
+++ b/README.md
@@ -176,7 +176,12 @@ Note that disabling languages won't make in general your vim startup any faster
Language packs are periodically updated using automated `build` script.
-Feel free to add your language, and send pull-request.
+Feel free to add your language, and send pull-request. In your pull request, please include:
+1. How you chose the particular repo from which to pull support for this language.
+2. An updated https://github.com/sheerun/vim-polyglot/blob/master/build .
+3. If at all possible, absolutely nothing else (in particular, please don't run `build` and include that in your PR).
+
+The easier it is to validate that the new language won't do anything wacky, the faster it'll be merged. In particular, languages that utilize global plugins (loaded for every filetype), or plugins with dangerous features (like `call` based on the contents of a file being edited), will never be merged, as they will be slow or dangerous, respectively.
## License