Add CONTRIBUTING.md based on our wiki articles #4136
Conversation
|
The file can go under .github btw ;) |
.github/CONTRIBUTING.md
Outdated
|
|
||
|  | ||
|
|
||
| ## Unthemed icons |
There was a problem hiding this comment.
Quick question: why is the unthemed icons section in CONTRIBUTING.md? I don't see why anyone who is interested in contributing would want this info.
There was a problem hiding this comment.
Also, you might want to change the README to link to CONTRIBUTING.md and we could drop the wiki page since this pull makes it redundant.
There was a problem hiding this comment.
Keep the contribution guidelines for how to submit pull requests and the procedure to follow. In addition to the "Contribution process" add sections for:
- New Icon: link to the design guidelines, reminder to update
data.json, and inform that user must include Circle & Square and other themes are optional. - Data File: an explanation of the structure and how to add/change it. This includes when adding an icon
- Python: we use pycodestyle linting, and basic explanation of @bil-elmoussaoui's validation scripts.
The design guidelines for each theme should stay in the wiki, especially considering they're only going to get longer as new themes are added.
The section on unthemed icons is also irrelivent for the contributing guidelines and should remain a wiki age.
Fixed the broken link to commit message guide. Added citation blocks for important parts to stand out.
|
Regarding our design guidelines. I'm currently using an Inkscape git build and in the HSL colour notation they changed the ranges for HSL from [0-255,0-255,0-255] to [0-360,0-100,0-100] which afaik is the correct way and how it's done in other graphics applications. This means our baseplate gradient will be 4L instead of 10L as of Inkscape 0.93. |
Added the first draft of the requested sections. The section on Python needs more info from @bil-elmoussaoui.
Extended the optimization options, and turned it into a subsection. [ci skip]
|
That's gonna be exhaustive, thanks for your efforts! |
Created an initial version of CONTRIBUTING.md mentioned in #4132
It contains the contents of the more relevant wiki pages.
Definitely needs some brainstorming, to specify what should go there, and what should be only linked to the wiki.