Skip to content
Snippets Groups Projects
Select Git revision
  • dev/close
  • master default protected
  • amend_commit
  • next
  • dev/nomodifiable
  • dev/discard_vselect
  • dev/catch_shell_error
  • dev/mapping_2
  • dev/issue_123
  • dev/issue_71
  • dev/mapping
  • dev/remove_end_commit
  • dev/stash
  • dev/test_commit
  • dev/save_commmit_msg
  • dev/push
  • dev/git_diff
  • dev/undo
  • gh-pages
  • dev/display
  • 1.8.0
  • 1.7.3
  • 1.7.2
  • 1.7.1
  • 1.7.0
  • 1.6.0
  • 1.5.2
  • 1.5.1
  • 1.5.0
  • 1.4.2
  • 1.4.1
  • 1.4
  • 1.3
  • 1.2
  • 1.0
  • 1.1
36 results

CONTRIBUTING.md

Blame
  • user avatar
    Jerome Reybert authored
    97654fb2
    History
    After you've reviewed these contribution guidelines, you'll be all set to contribute to this project.
    CONTRIBUTING.md 1.04 KiB

    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.

    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