Skip to content

Commit

Permalink
Add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jreybert committed Jan 20, 2017
1 parent 87c96fe commit 3e87cf1
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Contributions

Contributions and pull requests are welcome. Please take note of the following guidelines:

* **Work and push on `next` branch**. `git remote update; git checkout origin/next` before hacking. Exceptions for bugs in `master` branch and simple typo fix.
* Always rebase your work before push: `git pull --rebase origin next`
* Adhere to the existing style as much as possible; notably, tabulation indents and long-form keywords. Try to add comments for important changes/addings.
* Make targeted pull request: propose one feature/bugfix, and push only commit(s) related to this feature/bugfix.
* Any push to your pull request will trigger a regression job on [travis](https://travis-ci.org/jreybert/vimagit).

# Bugs

* To make it easier to reproduce, please supply the following:
* the version of `vim` or `nvim`
* the version of `git`
* the SHA1 of vimagit you're using
* the OS that you're using, including terminal emulator, GUI vs non-GUI
* a step by step command to reproduce the bug

0 comments on commit 3e87cf1

Please sign in to comment.