Mercurial > vim-gutentags
comparison CONTRIBUTING.md @ 172:02a94ff0db57
Add CONTRIBUTING file.
| author | Ludovic Chabant <ludovic@chabant.com> |
|---|---|
| date | Sun, 19 Feb 2017 20:47:50 -0800 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 171:18df731b1563 | 172:02a94ff0db57 |
|---|---|
| 1 | |
| 2 # Contributing | |
| 3 | |
| 4 You're thinking of contributing something to one of my projects? Oh my, I'm | |
| 5 quite honoured! Here's what you need to know. | |
| 6 | |
| 7 | |
| 8 ## Writing | |
| 9 | |
| 10 Clone the repository from either [BitBucket][] (if you're into Mercurial) or | |
| 11 [GitHub][] (if you're into Git). | |
| 12 | |
| 13 Next, create a branch for your work -- don't work directly on the `defaut` or | |
| 14 `master` branch. Instead, in Mercurial: | |
| 15 | |
| 16 $ hg bookmark my-fix | |
| 17 | |
| 18 Or, in Git: | |
| 19 | |
| 20 $ git checkout -b my-fix master | |
| 21 | |
| 22 Make your changes. Don't write anything that's not related to the fix you're | |
| 23 trying to contribute to the project. | |
| 24 | |
| 25 Write a simple, concise commit message. Gutentags isn't a big piece of code so | |
| 26 no need for strict message formats, so don't get fancy. | |
| 27 | |
| 28 | |
| 29 ## Testing | |
| 30 | |
| 31 If you can, try and test your changes on multiple platforms -- Ubuntu, MacOS, | |
| 32 and Windows are supposed to be supported. | |
| 33 | |
| 34 Also try to test your changes with: | |
| 35 | |
| 36 1. `g:gutentags_cache_dir` enabled and disabled. | |
| 37 2. A repository with spaces in its root path. | |
| 38 3. A repository with files and folders that have spaces in them. | |
| 39 | |
| 40 If you're on NeoVim, try and test on a "normal" Vim. | |
| 41 | |
| 42 | |
| 43 ## Pushing | |
| 44 | |
| 45 Once everything's fine, go on BitBucket or GitHub (again, depending on your | |
| 46 favorite source control tool) and create a fork if you haven't done so yet. Push | |
| 47 your changes to your fork, and create a pull request. Check the documentation of | |
| 48 either code portal for more information. | |
| 49 | |
| 50 Don't worry if you don't see any reply from me for a while. My turn around time | |
| 51 is measured in weeks, sometimes in months. This is normal -- I've got a job, | |
| 52 a family, and open-source hacking is only one of many awesome hobbies I spend my | |
| 53 limited free time on. | |
| 54 | |
| 55 That's it for now! And thanks a lot for contributing! | |
| 56 | |
| 57 | |
| 58 [bitbucket]: https://bitbucket.org/ludovicchabant/vim-gutentags | |
| 59 [github]: https://github.com/ludovicchabant/vim-gutentags | |
| 60 |