[vim/vim] How do I contribute to the project? (Discussion #13087)

62 views
Skip to first unread message

Gary Watson

unread,
Sep 14, 2023, 1:23:11 PM9/14/23
to vim/vim, Subscribed

I'm interested in contributing to the project... Starting up this discussion thread for two reasons...

  1. To find out the best way I can personally contribute
  2. Other people might be interested in contributing too, if so, whatever answers I get, they might find useful too :)

To that end...

  1. What tasks could I help with (assuming something from the issue tracker might be good)
  2. Are there any conventions I should know about to not get made fun of too much :)
  3. Where's the best place to communicate about such things (or is this discussion section it?)
    1. side note, is there a good live chat somewhere?

—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.Message ID: <vim/vim/repo-discussions/13087@github.com>

Yegappan Lakshmanan

unread,
Sep 14, 2023, 11:03:24 PM9/14/23
to vim...@googlegroups.com, reply+ACY5DGBZJLITVCGPQW...@reply.github.com, vim/vim, Subscribed
Hi,

On Thu, Sep 14, 2023 at 10:23 AM Gary Watson <vim-dev...@256bit.org> wrote:

I'm interested in contributing to the project... Starting up this discussion thread for two reasons...

  1. To find out the best way I can personally contribute
  2. Other people might be interested in contributing too, if so, whatever answers I get, they might find useful too :)

To that end...

  1. What tasks could I help with (assuming something from the issue tracker might be good)

Thanks for reaching out. I would recommend the following tasks:

1. Develop test scripts for the Vim features.  There are a large number of example scripts in the
    src/testdir directory (https://github.com/vim/vim/tree/master/src/testdir).  Vim has an extensive
    test infrastructure for developing different types of tests.  You can use the Vim code coverage
    information (https://app.codecov.io/gh/vim/vim/tree/master/src) to see the lines of codes that
   are not yet covered by tests and develop new tests for them.  Note that Vim currently has
   around 82% code coverage.  This will significantly help in improving the quality of Vim,
   refactoring of the code base and adding new features without introducing regressions.
   This work may not be as fancy as adding new features, but this helps more than adding
   new features to Vim.
2. Help with triaging the issues reported in Github issue tracker (https://github.com/vim/vim/issues).
3. Develop test scripts for the issues listed in Github.  This will help in reproducing the issue and
    adding it to the test suite.
4. Develop fixes for the issues reported in Github.  The latest todo.txt help 
    known issues and feature requests.
5. Develop new features listed in the todo.txt file.  The major features that currently need help
    are virtual text and classes.

  1. Are there any conventions I should know about to not get made fun of too much :)
  2. Where's the best place to communicate about such things (or is this discussion section it?)
    1. side note, is there a good live chat somewhere?



You can use the vim-dev mailing list for any development related discussion.

Regards,
Yegappan
 

vim-dev ML

unread,
Sep 14, 2023, 11:03:42 PM9/14/23
to vim/vim, vim-dev ML, Your activity

Hi,

On Thu, Sep 14, 2023 at 10:23 AM Gary Watson ***@***.***>
wrote:

> I'm interested in contributing to the project... Starting up this
> discussion thread for two reasons...
>
> 1. To find out the best way I can personally contribute
> 2. Other people might be interested in contributing too, if so,
> whatever answers I get, they might find useful too :)
>
> To that end...
>
> 1. What tasks could I help with (assuming something from the issue
> tracker might be good)
>
>
> 1. Are there any conventions I should know about to not get made fun
> of too much :)
> 2. Where's the best place to communicate about such things (or is this
> discussion section it?)
> 1. side note, is there a good live chat somewhere?
>
>
>
You can use the vim-dev mailing list for any development related discussion.

Regards,
Yegappan

—
Reply to this email directly, view it on GitHub,.
You are receiving this because you are subscribed to this thread.Message ID: <vim/vim/repo-discussions/13087/comments/7009075@github.com>

fritzophrenic

unread,
Sep 15, 2023, 9:35:01 PM9/15/23
to vim/vim, vim-dev ML, Comment

Are there any conventions I should know about to not get made fun of too much :)

Use Vim to develop your code or tests, and turn on the modelines feature. Most of the code (and probably the tests to, I'm not sure) uses a weird mix of tabs and spaces for indentation, but also puts the settings to generate that weird mix right in a modeline near the top or bottom of the file.

Also, for any distributed plugin, syntax, etc. files: check for a maintainer, listed in the file header. They'll usually be the person to actually incorporate the change so you probably need to send it to them (or @ them in a pull request if they're on GitHub).

—
Reply to this email directly, view it on GitHub.

You are receiving this because you commented.Message ID: <vim/vim/repo-discussions/13087/comments/7019230@github.com>

Shane-XB-Qian

unread,
Sep 23, 2023, 4:07:40 AM9/23/23
to vim/vim, vim-dev ML, Comment

uses a weird mix of tabs and spaces for indentation, but also puts the settings to generate that weird mix right in a modeline near the top or bottom of the file.

in Vim codebase, generally it is like this:

// to 'C code', put following at every its head:
/* vi:set ts=8 sts=4 sw=4 noet:
*/

" to 'legacy vim script', put following at every its bottom:
" vim: sw=2 sts=2 et

# to 'vim9script', put following at every its bottom:
# vim: sw=2 sts=2 et

IF you (or someone willing) like, you can start from here, help to add above to its all places.
// it may help to reduce odd indent.

—
Reply to this email directly, view it on GitHub.

You are receiving this because you commented.Message ID: <vim/vim/repo-discussions/13087/comments/7087803@github.com>

Shane-XB-Qian

unread,
Oct 7, 2023, 2:44:06 AM10/7/23
to vim/vim, vim-dev ML, Comment

:h develop.txt
#13294

—
Reply to this email directly, view it on GitHub,.
You are receiving this because you commented.Message ID: <vim/vim/repo-discussions/13087/comments/7215590@github.com>

Shane-XB-Qian

unread,
Oct 13, 2023, 3:15:16 AM10/13/23
to vim/vim, vim-dev ML, Comment

  • there perhaps would have formatter #13318 but following above advice and guidline maybe more important.
  • there should be also adding proper test each time for your change, please try best Not fix something while break something.

—
Reply to this email directly, view it on GitHub,.
You are receiving this because you commented.Message ID: <vim/vim/repo-discussions/13087/comments/7270835@github.com>

Shane-XB-Qian

unread,
Oct 13, 2023, 3:20:33 AM10/13/23
to vim/vim, vim-dev ML, Comment

  • finally (wish so) please read and follow and insist develop guideline and discussion here #12736 (reply in thread) about what vim is and what vim is not.

—
Reply to this email directly, view it on GitHub,.
You are receiving this because you commented.Message ID: <vim/vim/repo-discussions/13087/comments/7270888@github.com>

Shane-XB-Qian

unread,
Apr 3, 2024, 1:15:04 AM4/3/24
to vim/vim, vim-dev ML, Comment

and to the one there was no maintainer yet: #14378
// unless it was wrote and would be maintained by "you" (requester),
// otherwise it should contact the source repo/author,
// get permission or some discussion, etc.

—
Reply to this email directly, view it on GitHub,.
You are receiving this because you commented.Message ID: <vim/vim/repo-discussions/13087/comments/8992229@github.com>

Reply all
Reply to author
Forward
0 new messages