From babf417ed52ac7d1f5e038e43863ebee33b77512 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Joly?= Date: Sat, 16 Dec 2023 14:32:10 +0000 Subject: [PATCH] doc: add instructions to reproduce bugs --- Readme.md | 16 ++++++++++++++++ test/mock_setup.lua | 5 +++++ 2 files changed, 21 insertions(+) create mode 100644 test/mock_setup.lua diff --git a/Readme.md b/Readme.md index cc360e9..401c246 100644 --- a/Readme.md +++ b/Readme.md @@ -60,3 +60,19 @@ See [the help file][help] for more details and the mappings installed. [vb]: https://github.com/michamos/vim-bepo [help]: https://github.com/cljoly/bepo.nvim/blob/main/doc/bepo-nvim.txt [bepo]: https://bepo.fr/ + +## Reporting bugs + +Thanks for considering reporting a bug! + +We want to know if the issue is caused by: +1. the plugin itself +2. your user configuration +3. the system configuration + +Please try to reproduce the bug in nvim stripped of your user configuration by running: +``` +nvim --clean -u test/mock_setup.lua +``` + +If you can’t reproduce the bug in that “clean” nvim instance, it suggests that the bug comes from an interaction of the plugin with your user configuration. Please feel free to open an issue, mentioning that. diff --git a/test/mock_setup.lua b/test/mock_setup.lua new file mode 100644 index 0000000..9c7e9e5 --- /dev/null +++ b/test/mock_setup.lua @@ -0,0 +1,5 @@ +-- The assumption is that this file will be used as configuration file with nvim +-- running from the root of the repository +vim.opt.runtimepath:append(vim.fn.getcwd()) + +require("bepo").setup()