iheanyi / speakers-who-want-a-platform

A directory of underrepresented speakers for Q&A panels/conferences/events. No more excuses.
MIT License
436 stars 89 forks source link

Suggestion: turn list into table #21

Open morkro opened 8 years ago

morkro commented 8 years ago

Cool project! :v: I can see the list becoming very confusing the more people are added. How about turning it into a table (maybe even adding an avatar)?

iheanyi commented 8 years ago

Oh snap, i actually vibe with this idea. That's a good suggestion, thanks for the feedback! :D Now for the stream of PRs to slow down enough to convert it to a tabular format...

iheanyi commented 8 years ago

I think the ideal solution would be to also figure out a way to automate the generation of the README, because dealing with the merge conflicts and all that has been a pain.

morkro commented 8 years ago

Good idea!

I would go with a JSON like

[
  {
    "name": "Iheanyi Ekechukwu",
    "title": "Software Engineer",
    "job": "DigitalOcean",
    "website": "http://",
    "profiles": [{ "name": "Twitter", "link": "#" }, {}, {}]
  }
]

so contributors don't have to work with the table directly. Less merge conflicts and all that. Then just create a <table> from it and replace it in the README?

Sounds like a fun task :)

Ninja edit: I would like to create the logic for this, but could only start next week. What do you think?

joneshf commented 8 years ago

FWIW, I used to help maintain https://github.com/wbond/package_control_channel and it felt like merge conflicts were always present. Rather than the maintainers dealing with every conflict, we would sometimes ask the people contributing PRs if they could fix merge conflicts in their PR. Or submitting a new PR from the latest master if they didn't know how to fix the conflict. It does put the burden on the person contributing, so it's not without its trade-offs.

However, a HUGE mitigator of merge conflicts is ordering. Alphabetic or lexicographic ordering made it much less likely to have a conflict because less people were trying to update the same line. At some point the single json file was split into different files for each letter of the alphabet which also helped. That's something to keep in mind for the future.

siddharthkp commented 8 years ago

@iheanyi @morkro Another take on this -

Use issue/pull request template, you can have fixed questions. Removes the problem of merge conflicts because people are not editing the same file (or any file!) And the README can be updated via a post-merge hook.

What do you think? (I'll pick up the implementation if you like)

iheanyi commented 8 years ago

@siddharthkp Yeah, that would be nice as well. 🤔 I'm here for it.