Skip to content
This repository has been archived by the owner on Nov 10, 2019. It is now read-only.

Suggestion: turn list into table #21

Open
morkro opened this issue Sep 6, 2016 · 6 comments
Open

Suggestion: turn list into table #21

morkro opened this issue Sep 6, 2016 · 6 comments

Comments

@morkro
Copy link

morkro commented Sep 6, 2016

Cool project! ✌️
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
Copy link
Owner

iheanyi commented Sep 6, 2016

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
Copy link
Owner

iheanyi commented Sep 6, 2016

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
Copy link
Author

morkro commented Sep 7, 2016

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
Copy link

joneshf commented Sep 7, 2016

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
Copy link

siddharthkp commented Oct 27, 2016

@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
Copy link
Owner

iheanyi commented Nov 3, 2016

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

4 participants