nvim-lua / nvim-lua/kickstart.nvim

Recommend new users use the repo as a template instead of as a fork

Open
#1,740 14 comments 17 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lua
Stars
31.5k
Forks
46.6k
Avg merge
2d 16h
Merged PRs (30d)
4

Description

currently the recommended installation step is to fork the repo and then continue from there "kickstarting" your configuration. i think it would make more sense if the repo was converted into a template (similar to neovim-plugin-boilerplate) that way users do not get "out of sync" with something that they should only have used as a starting point.

https://github.com/nvim-lua/kickstart.nvim?tab=readme-ov-file#recommended-step
Image

Image Image

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the README section linked as the Recommended Step and review the current fork-based instructions. Update the onboarding guidance to use a repository template, and verify that the repository's template configuration and README consistently describe the new workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.