Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CONTRIBUTING.md file #132

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

dmint789
Copy link
Contributor

@dmint789 dmint789 commented Sep 1, 2024

This PR adds a CONTRIBUTING.md file, 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:

Digits

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_blocks to simply mirror, but I understand that that might be a step too far for some contributors. Just mentioning it here in case someone agrees with it.

@dmint789
Copy link
Contributor Author

dmint789 commented Sep 1, 2024

To-do:

  • Add point about an official event becoming unofficial too
  • Add guideline for where the competitors (circles) should be positioned
  • Add guideline about one-handed events having the puzzle above the hand shape

@dmint789
Copy link
Contributor Author

dmint789 commented Sep 7, 2024

@jfly any thoughts on this?

@dmint789
Copy link
Contributor Author

dmint789 commented Oct 1, 2024

@jfly kind ping :)

@jfly
Copy link
Member

jfly commented Dec 18, 2024

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants