diff options
author | Jongwook Choi <wookayin@gmail.com> | 2024-01-28 17:26:13 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-01-28 14:26:13 -0800 |
commit | 095f731af0191a405875544c738bbf352675ebf6 (patch) | |
tree | b841f25d4d9c37ec76ef47c2e35be8280ab94870 /CONTRIBUTING.md | |
parent | 01e82eba209a96f932d3497e580ab0ca749efafa (diff) | |
download | rneovim-095f731af0191a405875544c738bbf352675ebf6.tar.gz rneovim-095f731af0191a405875544c738bbf352675ebf6.tar.bz2 rneovim-095f731af0191a405875544c738bbf352675ebf6.zip |
docs: include backtrace for bug-crash #27065
Github Issue template:
- Add pointers to |dev-tools-backtrace|.
- Add pointers to CONTRIBUTING.md (Reporting Problems), which includes
additional helpful instructions for issue reporting.
- Search existing issues: include label `bug-crash` as well as `bug`.
CONTRIBUTING.md:
- Fix broken link on "stacktrace" after moving to help from wiki.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5704547689..d0e463866b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,8 +24,8 @@ Reporting problems - If a specific configuration or plugin is necessary to recreate the problem, use the minimal template in `contrib/minimal.lua` with `nvim --clean -u contrib/minimal.lua` after making the necessary changes. - [Bisect](https://neovim.io/doc/user/starting.html#bisect) your config: disable plugins incrementally, to narrow down the cause of the issue. - [Bisect][git-bisect] Neovim's source code to find the cause of a regression, if you can. This is _extremely_ helpful. -- When reporting a crash, [include a stacktrace](https://neovim.io/doc/user/faq.html#backtrace-linux). -- Use [ASAN/UBSAN](#clang-sanitizers-asan-and-ubsan) to get detailed errors for segfaults and undefined behavior. +- When reporting a crash, [include a stacktrace](https://neovim.io/doc/user/dev_tools.html#dev-tools-backtrace). +- Use [ASAN/UBSAN](#sanitizers-asan-and-ubsan) to get detailed errors for segfaults and undefined behavior. - Check the logs. `:edit $NVIM_LOG_FILE` - Include `cmake --system-information` for build-related issues. |