kickstart.nvim icon indicating copy to clipboard operation
kickstart.nvim copied to clipboard

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

Open stephansama opened this issue 4 months ago • 3 comments

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

stephansama avatar Oct 06 '25 16:10 stephansama

I like this opinion. This can prevent users from sending a false pull request.

guru245 avatar Dec 02 '25 12:12 guru245

No. This is actually a great feature and allows you to update changes to your configuration, if you so desire. I have done this multiple times and regularly update my own fork.

Guide should be updated, recommending you to do your changes in your own branch after forking. This way you can easily sync changes to your fork's main branch and rebase fast forward them.

I have used this workflow over a year with only minor merge conflicts.

False pull requests might be a nuisance to the maintainers, but also quite easy to notice.

Sefriol avatar Dec 04 '25 18:12 Sefriol

No. This is actually a great feature and allows you to update changes to your configuration, if you so desire. I have done this multiple times and regularly update my own fork.

Guide should be updated, recommending you to do your changes in your own branch after forking. This way you can easily sync changes to your fork's main branch and rebase fast forward them.

I have used this workflow over a year with only minor merge conflicts.

False pull requests might be a nuisance to the maintainers, but also quite easy to notice.

This is an interesting point. I personally do not use kickstart so I am not super opinionated on it. I just noticed this when I was helping someone who uses it. And thought it could potentially help others. Curious what others think as well.

stephansama avatar Dec 08 '25 03:12 stephansama