abbreviations-in-code icon indicating copy to clipboard operation
abbreviations-in-code copied to clipboard

Request: Make the project more inclusive and accessible

Open oood opened this issue 2 years ago β€’ 9 comments

Requests:

  • Do not use master as the default branch name anymore.

  • Make documentation easier for colorblind (CVD) readers.

Rationale:

  • Since 2020, GitHub has changed the default branch of the new repository from the original master to the less offensive main. This is part of the Software Freedom Conservancy's advocacy for a more inclusive programming environment.

  • According to the data, about 8% of men and 0.5% of women have difficulty distinguishing between red and green colors.

Suggestions:

  • Change to the less offensive main, or another name.

  • Use text to explain how recommended an abbreviation is, or other emojis πŸ‘/πŸ‘Œ/πŸ‘Ž.

This issue is a fork of a previous thread (#41), you may be interested in reading the previous discussion history.

oood avatar Mar 03 '23 20:03 oood

  • Use text to explain how recommended an abbreviation is, or other emojis πŸ‘/πŸ‘Œ/πŸ‘Ž.

Great πŸ‘

T1xx1 avatar Mar 03 '23 21:03 T1xx1

Great πŸ‘

Not sure if it can be considered as the final solution, since a single color hand lacks inclusivity. that's why I prefer to use a simple text as an explanation of the degree of recommendation.

oood avatar Mar 03 '23 21:03 oood

Thank you for bringing up these points. I think :green_circle:, :yellow_circle: and :red_circle: are very intuitive for ~95% of people. So I think we should keep these in some form.

What about this?

  • :green_circle: abbr1
  • :yellow_circle: abbr1
  • :red_circle: ~abbr1~

Although italic and normal are hard to distinguish, but yellow is usually not subject of color blindness.

What do you think?

kisvegabor avatar Mar 04 '23 14:03 kisvegabor

Thank you for bringing up these points. I think :green_circle:, :yellow_circle: and :red_circle: are very intuitive for ~95% of people. So I think we should keep these in some form.

What about this?

  • :green_circle: abbr1
  • :yellow_circle: abbr1
  • :red_circle: ~abbr1~

Although italic and normal are hard to distinguish, but yellow is usually not subject of color blindness.

What do you think?

Also this method seems good

T1xx1 avatar Mar 04 '23 15:03 T1xx1

Thank you for bringing up these points. I think 🟒, 🟑 and πŸ”΄ are very intuitive for ~95% of people. So I think we should keep these in some form.

In fact, Github's colors are carefully designed, it uses green and purple to mark open and closed issues.

Green 🟒 and redπŸ”΄ can be hard to tell apart for some, but purple 🟣 is a lot better.

RedπŸ”΄ and blueπŸ”΅ are also fine for most colorblind readers.

And, if you're going to develop it into a dictionary, then I think there can be multiple formats out there.

We don't have to tangle here.

There can be a raw data there, and then use GitHub Actions to automatically generate dictionaries in various formats. like json, and red and green. we only need to maintain a basic raw data.

oood avatar Mar 04 '23 16:03 oood

So, I think we don't really need to care too much about the color of the circle, we just need to create a raw database, then maintain the database, and use scripts to automatically generate readme files.

oood avatar Mar 04 '23 17:03 oood

I've just suggested the same thing here :slightly_smiling_face:

kisvegabor avatar Mar 04 '23 18:03 kisvegabor

Green 🟒 and redπŸ”΄ can be hard to tell apart for some, but purple 🟣 is a lot better.

I am happy to switch red to purple, if it increases readability for the last 5% of humans. It is also a nice purple and maybe even less of a "hard no".

philipeachille avatar Mar 05 '23 22:03 philipeachille

I am happy to switch red to purple, if it increases readability for the last 5% of humans. It is also a nice purple and maybe even less of a "hard no".

Yes, glad you can think so.

But now making the database format is prioritized over this issue, because once we update the abbreviations in the database, then, we can create lists in various formats, suitable for all people and all machines.

Please discuss the format of the database here: #48

oood avatar Mar 05 '23 23:03 oood