diff options
| author | Ihsan Tonuzi <115842560+iton0@users.noreply.github.com> | 2024-12-29 12:00:16 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-12-29 12:00:16 -0500 |
| commit | 7fc11051a84757285cd23faa8d2bda9418c47f2c (patch) | |
| tree | 84780934648811e80a68f7da546a6f6c05184fd2 | |
| parent | 77e19835bf529573e7b21724bf104b76f307334a (diff) | |
| download | dots-7fc11051a84757285cd23faa8d2bda9418c47f2c.tar.gz | |
chore: add pre-issue requirements (#1288)
* chore: add pre-issue requirements
Based on #1285
* docs: add header about documentation
Based on #1285
| -rw-r--r-- | nvim/.github/ISSUE_TEMPLATE/bug_report.md | 11 | ||||
| -rw-r--r-- | nvim/README.md | 7 |
2 files changed, 15 insertions, 3 deletions
diff --git a/nvim/.github/ISSUE_TEMPLATE/bug_report.md b/nvim/.github/ISSUE_TEMPLATE/bug_report.md index 2ad4d31..55b45b0 100644 --- a/nvim/.github/ISSUE_TEMPLATE/bug_report.md +++ b/nvim/.github/ISSUE_TEMPLATE/bug_report.md @@ -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. --> diff --git a/nvim/README.md b/nvim/README.md index 08cecfa..aa5f4fc 100644 --- a/nvim/README.md +++ b/nvim/README.md @@ -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: |