Add CONTRIBUTING.md file #231
Conversation
|
I wonder what kind of help we need with documentation and tooling? |
|
We need testing, writing, opinions, etc. Writing/updating the documentation is quite a task, actually, and I am not sure how to start it correctly. For the tooling: feedback about checks, about colortemplate, etc. |
| - There are a bunch of samples in `colors/tools/` to be used for screenshots. | ||
| - It might be useful to discuss orientations with the team before going on with your template. | ||
|
|
||
| ## Helping with documentation |
There was a problem hiding this comment.
Although colorschemes bundled with vim do not require documentation in vim, they should work as is, we might need to document....
|
|
||
| TBC | ||
|
|
||
| ## helping with tooling |
There was a problem hiding this comment.
We're heavily dependent on Colortemplate for colorscheme authoring. Any contribution (bug reports, code fixes, documentation updates, etc) there would also help us.
There are helper scripts in colors/tools/ directory that cover different use cases, opening vim in various states to check colorschemes visually. It might be handy to have more use cases covered there or make existing scripts "deeper".
There is also pretty basic colors/tools/check_colors.vim script that is supposed to be used as a general consistency check for a new or updated colorschemes. It would be nice to enrich it with more checks and eventually organize CI/CD for each new PR to run against it.
Related: #221