SailReal
/
nvim
1
0
Fork 0
Code Issues Pull Requests 2 Packages Projects Releases Wiki Activity

chore: add pre-issue requirements (#1288) 

* chore: add pre-issue requirements

Based on #1285

* docs: add header about documentation

Based on #1285
This commit is contained in:
Ihsan Tonuzi 2024-12-29 12:00:16 -05:00 committed by GitHub
parent e84e187f3c
commit 7ddaab3ffd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@ -9,6 +9,13 @@ assignees: ''
<!-- Any bug report not following this template will be immediately closed. Thanks -->
## Before Reporting an Issue
- I have read the kickstart.nvim README.md.
- I have read the appropiate plugin's documentation.
- I have searched that this issue has not been reported before.
- [ ] **By checking this, I confirm that the above steps are completed. I understand leaving this unchecked will result in this report being closed immediately.**
## Describe the bug
<!-- A clear and concise description of what the bug is. -->
@ -18,8 +25,8 @@ assignees: ''
## Desktop
<!-- please complete the following information. -->
- OS:
- Terminal:
- OS:
- Terminal:
## Neovim Version
<!-- Output of running `:version` from inside of neovim. -->

7
README.md
View File

@ -103,10 +103,15 @@ nvim
That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
the current plugin status. Hit `q` to close the window.
#### Read The Friendly Documentation
Read through the `init.lua` file in your configuration folder for more
information about extending and exploring Neovim. That also includes
examples of adding popularly requested plugins.
> [!NOTE]
> For more information about a particular plugin check its repository's documentation.
### Getting Started
@ -135,7 +140,7 @@ examples of adding popularly requested plugins.
* The main purpose of kickstart is to serve as a teaching tool and a reference
configuration that someone can easily use to `git clone` as a basis for their own.
As you progress in learning Neovim and Lua, you might consider splitting `init.lua`
into smaller parts. A fork of kickstart that does this while maintaining the
into smaller parts. A fork of kickstart that does this while maintaining the
same functionality is available here:
* [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
* Discussions on this topic can be found here: