search

jsonresume / resume-cli

CLI tool to easily setup a new resume 📑
https://jsonresume.org
MIT License
4.56k stars 389 forks source link

Specification Questions/Suggestions #26

Closed shea256 closed 10 years ago

shea256 commented 10 years ago

Hi, I have a few questions/suggestions for the specification. Hopefully this is the appropriate place to put it but here goes:

  1. Why is "bio" the container for "name", "email", "phone", "summary", "location", "websites" and "profiles"? I've dealt with many specs before and it seems to be the case that the less nesting there is, the easier it is on the developer. Less if statements, potential errors, etc. Github, for example, only uses top-level keys (https://api.github.com/users/rxl). I'm not suggesting you go that far, but I think it would make sense to take all of the fields currently in the "bio" dictionary out and make them their own top-level keys.
  2. There should be an option for fullName, which can override the first and last name fields. Some apps will only have that field and won't be able to necessarily reliably parse out the first and last names automatically.
  3. The "profiles" field contains accounts for social networks, etc. Can I put my Skype username in there? Would the name "accounts" be a more appropriate label for this list then, since many accounts don't actually have profiles? Just a thought.
  4. Couldn't there be a standard format for phone numbers? I'm just thinking that this could be helpful for any application that enables calling and reads the JSON resumes.
  5. Can you add a "formatted" field for location as a fallback, just in case someone wants to specify their location as a string? This is what Gravatar does and it's also compatible with the format that Twitter uses for it's "location" field (it's just a string).
ocram commented 10 years ago

You should create the issue here: https://github.com/jsonresume/resume-schema/issues?state=open

Anyway:

  1. True
  2. Already being discussed there
  3. Should definitely be E.164
  4. The conversion could be done by a GUI, lat/long is definitely better for machine-readability.
shea256 commented 10 years ago

Perfect, thank you Marco.

What about item 3 ("profiles" vs "accounts")? I believe your number 3 addresses my number 4, and the same for your 4 and my 5.

Anyway, I'll create the issue there.