Add CONTRIBUTING.md file #132
Conversation
|
To-do:
|
|
@jfly any thoughts on this? |
|
@jfly kind ping :) |
|
@lgarron and I will talk about once we've got our heads out of twsearch land, hopefully in a month or two. Until then, I'm ok adding more unofficial icons. |
lgarron
force-pushed
the
main
branch
2 times, most recently
from
32bab7a to
4c0307b
Compare
Any update? |
|
|
||
| 1. It should be clear what event the icon represents from the file name. | ||
| 2. Icon names should be concise and ideally not exceed 16 characters. Words may be shortened, as long as guideline 1 isn't broken (e.g. `pyram` for Pyraminx). | ||
| 3. Underscores (`_`) must be used as delimiters. **Never** use dashes (`-`), as they are used as delimiters for round IDs (e.g. `333-r1`). |
There was a problem hiding this comment.
used as delimiters for round IDs (e.g.
333-r1).
This is reference to WCIF, right? Let's link to it here.
There was a problem hiding this comment.
Yeah, it is. I'll add a link.
| 2. Icon names should be concise and ideally not exceed 16 characters. Words may be shortened, as long as guideline 1 isn't broken (e.g. `pyram` for Pyraminx). | ||
| 3. Underscores (`_`) must be used as delimiters. **Never** use dashes (`-`), as they are used as delimiters for round IDs (e.g. `333-r1`). | ||
| 4. Naming conventions: | ||
| 1. For NxN events and their derivatives, use `NNN` to represent the puzzle (e.g. `555` for 5x5x5 Cube). |
There was a problem hiding this comment.
nit: Add an additional space to all of these to get markdown to treat them as a sublist.
|
|
||
| ## Contributing | ||
|
|
||
| See the `(CONTRIBUTING.md)[https://github.com/cubing/icons/blob/main/CONTRIBUTING.md]` document. |
There was a problem hiding this comment.
nit: Remove the back-tics, use a relative link:
| See the `(CONTRIBUTING.md)[https://github.com/cubing/icons/blob/main/CONTRIBUTING.md]` document. | |
| See the [CONTRIBUTING.md](CONTRIBUTING.md) document. |
|
@jfly oh, my bad, I totally forgot about this PR. I'll try to implement the changes you asked for soon. |
2 participants
This PR adds a
CONTRIBUTING.mdfile, which outlines a bunch of guidelines for contributing to this repo. This was discussed in #130. The digits mentioned in the document would look like this:The main reason I mentioned the digits was to enable the addition of icons for 8x8+ puzzles (#125).
According to the naming guidelines in this file, the code changes below should be made. I believe I am the only user of all of these, since I created all of these icons, and it hasn't been that long since then, so there shouldn't be any other affected users. And even if there are other users, they'd still be using the old package version with the icon codes their code expects.
333_oh_bld_team_relay -> 333_oh_bld_3p_relay
333bf_2_person_relay -> 333bf_2p_relay
333bf_3_person_relay -> 333bf_3p_relay
333bf_4_person_relay -> 333bf_4p_relay
333bf_8_person_relay -> 333bf_8p_relay
miniguild_2_person -> miniguild_2p
I'd also like to change both uses of
mirror_blocksto simplymirror, but I understand that that might be a step too far for some contributors. Just mentioning it here in case someone agrees with it.