Skip to content

Commit 12fb1da

Browse files
authored
chore: add pre-issue requirements (nvim-lua#1288)
* chore: add pre-issue requirements Based on nvim-lua#1285 * docs: add header about documentation Based on nvim-lua#1285
1 parent 94a911b commit 12fb1da

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@ assignees: ''
99

1010
<!-- Any bug report not following this template will be immediately closed. Thanks -->
1111

12+
## Before Reporting an Issue
13+
- I have read the kickstart.nvim README.md.
14+
- I have read the appropiate plugin's documentation.
15+
- I have searched that this issue has not been reported before.
16+
17+
- [ ] **By checking this, I confirm that the above steps are completed. I understand leaving this unchecked will result in this report being closed immediately.**
18+
1219
## Describe the bug
1320
<!-- A clear and concise description of what the bug is. -->
1421

@@ -18,8 +25,8 @@ assignees: ''
1825

1926
## Desktop
2027
<!-- please complete the following information. -->
21-
- OS:
22-
- Terminal:
28+
- OS:
29+
- Terminal:
2330

2431
## Neovim Version
2532
<!-- Output of running `:version` from inside of neovim. -->

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,15 @@ nvim
103103
That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
104104
the current plugin status. Hit `q` to close the window.
105105

106+
#### Read The Friendly Documentation
107+
106108
Read through the `init.lua` file in your configuration folder for more
107109
information about extending and exploring Neovim. That also includes
108110
examples of adding popularly requested plugins.
109111

112+
> [!NOTE]
113+
> For more information about a particular plugin check its repository's documentation.
114+
110115

111116
### Getting Started
112117

@@ -135,7 +140,7 @@ examples of adding popularly requested plugins.
135140
* The main purpose of kickstart is to serve as a teaching tool and a reference
136141
configuration that someone can easily use to `git clone` as a basis for their own.
137142
As you progress in learning Neovim and Lua, you might consider splitting `init.lua`
138-
into smaller parts. A fork of kickstart that does this while maintaining the
143+
into smaller parts. A fork of kickstart that does this while maintaining the
139144
same functionality is available here:
140145
* [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
141146
* Discussions on this topic can be found here:

0 commit comments

Comments
 (0)