Thanks for considering contributing to neovim. To make the process as smooth as possible we would ask you to follow the guidelines below.
See Communicating. Raise documentation issues.
Neovim uses waffle.io, so check there first.
You can also ask for an issue to be assigned to you. Ideally wait until we assign it to you to minimize work duplication.
- Search existing issues before raising a new one.
- Include as much detail as possible. In particular, we need to know which OS you're using.
- Make it clear in the issue tracker what you are working on, so that someone else doesn't duplicate the work.
- Use a feature branch, not master.
- Rebase your feature branch onto origin/master before raising the PR.
- Keep up to date with changes in master so your PR is easy to merge.
- Be descriptive in your PR message: what is it for, why is it needed, etc.
- Make sure the tests pass (TODO: we need to make this easier with travis etc.)
- Squash related commits as much as possible.