jyapayne/vimspector
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Require minimal reproduction in contributing guide.

Browse source
This commit is contained in:
Ben Jackson 2020-08-02 18:16:32 +01:00 • committed by GitHub
commit 750e68bdf5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

19
CONTRIBUTING.md
View file

@ -45,6 +45,7 @@ of the following reasons:
* The [issue template][issue-template] was not completed * The [issue template][issue-template] was not completed
* The issue or comment is off-topic * The issue or comment is off-topic
* The issue does not represent a Vimspector bug or feature request * The issue does not represent a Vimspector bug or feature request
* The issue cannot be reasonably reproduced using the minimal vimrc
* etc. * etc.
Issue titles are important. It's not usually helpful to write a title like Issue titles are important. It's not usually helpful to write a title like
@ -60,6 +61,24 @@ diagnostics without having to spend time asking for them, and waiting for the
response. This means *you get a better answer, faster*. So it's worth it, response. This means *you get a better answer, faster*. So it's worth it,
honestly. honestly.
### Reproduce your issue with the minimal vimrc
Many problems can be caused by unexpected configuration or other plugins.
Therefore when raising an issue, you must attempt to reproduce your issue
with the minimal vimrc provided, and to provide any additional changes required
to that file in order to reproduce it. The purpose of this is to ensure that
the issue is not a conflict with another plugin, or a problem unique to your
configuration.
If your issue does _not_ reproduce with the minimal vimrc, then you must say so
in the issue report.
The minimal vimrc is in `support/test/minimal_vimrc` and can be used as follows:
```
vim -Nu /path/to/vimspector/support/minimal_vimrc
```
## Pull Requests ## Pull Requests
When contributing pull requests, I ask that: When contributing pull requests, I ask that: