nvim-mini / nvim-mini/mini.nvim

mini.comment to be able to beautify comments and texts

Open
#1,225 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature-request mini.comment mini.misc
Dominant language
Lua
Stars
9.5k
Forks
310
Avg merge
4h 16m
Merged PRs (30d)
1

Description

Contributing guidelines
Module(s)

mini.comment

Description

first. thank you so much for all the work you do.

comments are so important to document code.
so i think it's a good addition to mini.comment to be able to beautify comments and plain texts
this is how comment-box.nvim looks like
comment-box.nvim

better-comments

Contributor guide

Open the contributing guide

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 reading the mini.comment module and reviewing the linked comment-box.nvim example. The request needs a concrete definition of which comment and plain-text beautification behaviors are wanted before implementation can be scoped. Done would mean an agreed feature set is implemented and its expected output is verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
tooling
Issue type
Feature
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.