search

vim / colorschemes

colorschemes for Vim
289 stars 23 forks source link

Header comment of "remakes" #43

Closed habamax closed 3 years ago

habamax commented 3 years ago

What should be put in the header comments?

" Name:         shine
" Description:  Remake of default shine colorscheme
" Author:       Updated by Maxim Kim <habamax@gmail.com>
" Maintainer:   Originally maintained by Yasuhiro Matsumoto <mattn@mail.goo.ne.jp>
" License:      Vim License (see `:help license`)
" Last Updated: 16.11.2020 11:43:28

Specifically Author and Maintainer?

I think we should leave original maintainer/author and put some url to current https://github.com/vim/colorschemes ?

" Name:            shine
" Description:     Remake of default shine colorscheme
" Original Author: Yasuhiro Matsumoto <mattn@mail.goo.ne.jp>
" Maintainer:      https://github.com/vim/colorschemes
" License:         Vim License (see `:help license`)
" Last Updated: 16.11.2020 11:43:28
romainl commented 3 years ago

How about something like this?

" Name:         shine
" Description:  Light colorscheme inspired by normal text editors
" Maintainers:  Yasuhiro Matsumoto <mattn@mail.goo.ne.jp>
"               Maxim Kim <habamax@gmail.com>
" Website:      https://github.com/vim/colorschemes
" License:      Vim License (see `:help license`)
" Last Updated: 16.11.2020 11:43:28

Note that mattn is mentioned as maintainer in the current file.

habamax commented 3 years ago

I am not sure multilines are possible with colortemplate, other than that it is fine for me.

image

@lifepillar, could you add smth like this?

lifepillar commented 3 years ago

Sure, I can do it. But give me a few days.

habamax commented 3 years ago

Sure, I can do it. But give me a few days.

Thx! Also, looks like, Author: shouldn't be mandatory too. Either Maintainer(s) or Author should be enough I think.

romainl commented 3 years ago

I think "maintainers" covers both "original author" and "took responsibility in absence of original author": meaning a more general "people involved in the project". But I can see why one may want "author" and "maintainers" to be clearly separated.

Then there is the case of listing individual contributors:

" Contributors:    Foo Bar <foobar@gmail.com>
"                  Bar Baz <barbaz@hotmail.com>

Shall we do this in the name of transparency or would it be too much? Such a list seems hard to maintain manually so that would count as a con.

habamax commented 3 years ago

Shall we do this in the name of transparency or would it be too much? Such a list seems hard to maintain manually so that would count as a con.

I was thinking original author/maintainer would be enough and then for details goto website and check who contributor(s) is/are.

romainl commented 3 years ago

I'm OK with that.

habamax commented 3 years ago

I'm OK with that.

Good! I think under Maintainer: key we can clarify he/she was original and now it is maintained on github colorschemes.

So, @lifepillar looks like we don't need multiple maintainers/authors key but Colortemplate enforce Author key which for some colorschemes we don't have, e.g. shine only has maintainer.

habamax commented 3 years ago

@romainl how about this?

" Name:         shine
" Description:  Light colorscheme inspired by normal text editors.
" Author:       Original author is Yasuhiro Matsumoto <mattn@mail.goo.ne.jp>
" Maintainer:   Original maintainer is Yasuhiro Matsumoto <mattn@mail.goo.ne.jp>
" Website:      https://github.com/vim/colorschemes
" License:      Vim License (see `:help license`)
" Last Updated: 16.11.2020 13:52:15
romainl commented 3 years ago

So…

This should work.

lifepillar commented 3 years ago

Colortemplate enforce Author key which for some colorschemes we don't have

Every color scheme has an author. If for some color scheme the author is unknown or anonymous, it should be noted as such.

habamax commented 3 years ago

Every color scheme has an author. If for some color scheme the author is unknown or anonymous, it should be noted as such.

I doubled maintainer key and renamed it to author :). I don't know if they were original authors or not and there is no easy way to get this info. Let's hope real original authors will be ok with it.