Skip to content

Increase readability of label data files #85

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

Closed
1 task
dhruvkb opened this issue Sep 25, 2020 · 4 comments · Fixed by #104
Closed
1 task

Increase readability of label data files #85

dhruvkb opened this issue Sep 25, 2020 · 4 comments · Fixed by #104
Assignees
Labels
💻 aspect: code Concerns the software code in the repository 🤖 aspect: dx Concerns developers' experience with the codebase ✨ goal: improvement Improvement to an existing feature good first issue New-contributor friendly help wanted Open to participation from the community 🟩 priority: low Low priority and doesn't need to be rushed 🏁 status: ready for work Ready for work

Comments

@dhruvkb
Copy link
Member

dhruvkb commented Sep 25, 2020

Problem

Both labels.json and skills.json are not very readable for the following reasons:

  • both are JSON files, which are not very readable for humans.
  • currently the labels.json file uses emoji as unicode glyphs, which look like two codepoints in a string. It's not possible to identify the emojis from the text.

Description

GitHub allows using "colon-style markup" instead of native emoji. We should use that as the value of the emoji key. Additionally YAML would be a much better option for files that are manually read or written.

Alternatives

The current implementation works. Not working on the issue is the alternative.

Implementation

  • I would be interested in implementing this feature.
@dhruvkb dhruvkb added 🟩 priority: low Low priority and doesn't need to be rushed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work ✨ goal: improvement Improvement to an existing feature 💻 aspect: code Concerns the software code in the repository good first issue New-contributor friendly Hacktoberfest help wanted Open to participation from the community 🏁 status: ready for work Ready for work 🤖 aspect: dx Concerns developers' experience with the codebase and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Sep 25, 2020
@JuanVqz
Copy link

JuanVqz commented Sep 25, 2020

Hello! Should I change the JSON file to Yaml file? I can do it if you allow me.
For emojis, should be like the following line?

emoji: ”: strawberry:”

@dhruvkb
Copy link
Member Author

dhruvkb commented Sep 25, 2020

Yes @JuanVqz, please change the JSON files to YAML and the emojis to their corresponding :xyz: representation as in this cheat sheet.

@JuanVqz
Copy link

JuanVqz commented Oct 7, 2020

sorry I haven't experience with python and I didn't see I need to do something with it, otherwise, I didn't take it.
can I fix the .yml files to finish this?

@dhruvkb
Copy link
Member Author

dhruvkb commented Oct 7, 2020

Yeah okay, just make sure the JSON and YML files are in sync and I'll make the remaining Python changes.

@dhruvkb dhruvkb mentioned this issue Nov 29, 2020
7 tasks
@dhruvkb dhruvkb added 🛠 goal: fix Bug fix ✨ goal: improvement Improvement to an existing feature and removed Hacktoberfest ✨ goal: improvement Improvement to an existing feature 🛠 goal: fix Bug fix labels Nov 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🤖 aspect: dx Concerns developers' experience with the codebase ✨ goal: improvement Improvement to an existing feature good first issue New-contributor friendly help wanted Open to participation from the community 🟩 priority: low Low priority and doesn't need to be rushed 🏁 status: ready for work Ready for work
Projects
None yet
2 participants