nvim-lua / nvim-lua/kickstart.nvim

I would like to contribute, a "vision", "goals", "philosophy", "principles" document might help

Open
#1,372 3 comments 6 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

Hi all,

I have read the post on reddit that called for contribution/maintainers. And I would love to participate,
this is my first actual comment on this repo.

I have started following the issues and have read through some of the backlog. My impression is that there is no "clear" written document that expresses what this project is about. There are these 3 bullet points in the Readme, but this is not something that helps with deciding which features to include. Maybe the maintainers/we (As in, I would like to participate but do not feel confident dictating something) could write something up. There is even some potential to include it in the issue templates. That would encourages users that suggest new features to confirm that their suggestion follows these principles. This would ease maintenance by filtering some of these suggestions/providing guidelines for their acceptance.

If there is some consensus that this would be useful, I will happily help out with the creation.

Looking forward to helping out,
Aaron

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 by reviewing the README's three bullet points and the existing issue templates. The issue needs maintainer consensus on the project's vision, goals, philosophy, or principles before work can begin; it is done when an agreed document and any corresponding template guidance are clearly defined.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.