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

Document requirements for a language color change #4487

Merged
merged 2 commits into from
Apr 10, 2019

Conversation

lildude
Copy link
Member

@lildude lildude commented Apr 5, 2019

Description

Changing a language's colour has become a bit of a hot topic recently so I'm adding a section to the CONTRIBUTING.md, PR template and issue template advising on what is now required for a colour change.

Checklist:

Doesn't apply as this is a documentation change.

@lildude lildude requested review from pchaigno and Alhadis April 8, 2019 09:55
Copy link
Collaborator

@Alhadis Alhadis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It took all my effort not to review this with only s/color/colour/, but I managed.

CONTRIBUTING.md Outdated Show resolved Hide resolved
If there are official branding guidelines to support the colour choice, please link to those too.

Please note that Linguist currently implements a [color proximity test][color-proximity-test] to ensure colors are sufficiently different from one another so you may not be able to use the precise color you want - reds and blues are really popular.
As such, we recommend you test the color change locally before making your plea to the wider language community.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before we promulgate this as a restriction, we should really wait for the final consensus as to whether or not the colour-proximity requirements will ever be axed in future.

We have no idea how long it might take to reach a consensus. Members of a language's community could spend weeks bikeshedding as to whether a compromise for their project's official branding should be taken, simply their shade of red was too close to 5-6 other shades of red. How bad would we (GitHub/Linguist) look if the colour restriction was suddenly abolished the day after they reached an agreement?

Obviously we can't expect it to take that long to decide on a hex colour value, but you know what people are like...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before we promulgate this as a restriction, we should really wait for the final consensus as to whether or not the colour-proximity requirements will ever be axed in future.

We may be waiting a while. I've given my issue a nudge to see if I can get a quick response, but it's in a long list of other higher priority issues. The best thing to do is assume the status quo for now, we can easily remove the note when we remove the test.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair enough, then.

I might be getting anxious for the outcome because there's a lot hanging on the removal of proximity requirements. We can finally degroup the languages touched on in #4291, add official colours for data/prose formats (which matters now that we have linguist-detectable), and a whole heap of other nags...

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@lildude
Copy link
Member Author

lildude commented Apr 8, 2019

It took all my effort not to review this with only s/color/colour/, but I managed.

😆 It really hurt to write "color" so many times but it's GitHub's preferred version of English so we gotta use it.

@lildude lildude merged commit 7694e11 into master Apr 10, 2019
@lildude lildude deleted the lildude/note-on-colour-change branch April 10, 2019 13:10
@github-linguist github-linguist locked as resolved and limited conversation to collaborators Jun 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants