diff options
| author | Phil Crosby | 2014-10-19 22:58:46 -0700 | 
|---|---|---|
| committer | Phil Crosby | 2014-10-19 22:58:46 -0700 | 
| commit | a2e7ed7cda8b691486dad582c900307944ec8863 (patch) | |
| tree | f7fc1eacad9e7623bc29cfe95667989a394d1500 | |
| parent | 24e50a48344ac38dc49af75aa7661377282ce0cd (diff) | |
| download | vimium-a2e7ed7cda8b691486dad582c900307944ec8863.tar.bz2 | |
Add some guidelines for PRs
| -rw-r--r-- | CONTRIBUTING.md | 23 | 
1 files changed, 23 insertions, 0 deletions
| diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 41ce7736..9382a020 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,6 +74,29 @@ reports:  When you're done with your changes, send us a pull request on Github. Feel free to include a change to the  CREDITS file with your patch. +## What makes for a good feature request/contribution to Vimium? + +Good features: + +* Useful for lots of Vimium users +* Require no/little documentation +* Useful without configuration +* Intuitive or leverage strong convention from Vim +* Work robustly on most/all sites + +Less-good features: + +* Are very niche, and so aren't useful for many Vimium users +* Require explanation +* Require configuration before it becomes useful +* Unintuitive, or they don't leverage a strong convention from Vim +* Might be flaky and don't work in many cases + +We use these guidelines, in addition to the code complexity, when deciding whether to merge in a pull request. + +If you're worried that a feature you plan to build won't be a good fit for core Vimium, just open a github +issue for discussion or send an email to the Vimium mailing list. +  ## How to release Vimium to the Chrome Store  This process is currently only done by Phil or Ilya. | 
