Skip to content
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

Change list format in Contributors.md #6663

Closed
strdr4605 opened this issue Sep 17, 2018 · 3 comments
Closed

Change list format in Contributors.md #6663

strdr4605 opened this issue Sep 17, 2018 · 3 comments

Comments

@strdr4605
Copy link

strdr4605 commented Sep 17, 2018

🐞 Problem

Readability of the Contributors.md file.

🎯 Goal

Users will see how many people contributed.

💡 Possible solutions

always use 1. instead of - in list items.
example:

  1. First
  2. Second
  3. Third

all elements created with 1.

@Roshanjossey
Copy link
Member

@strdr4605, There are some problems to making this change.

The biggest problem is that multiple people edit this file at the same time. Everybody should then add their name to the end of the list. So multiple people would put down the same number. Also there will be a LOT of merge conflicts. Maintainers will have to resolve them. (That's why we have a suggestion in the readme to add name at a random position)

To know how many people there are, You can do a blame or edit in GitHub. In your local, you can use a text editor with line numbers to find how many people there are.

If you have any questions or need any clarifications about this, feel free to comment :)

@strdr4605
Copy link
Author

strdr4605 commented Sep 19, 2018

@Roshanjossey , does not matter what number will people write.
"o add the name at a random position" is a great solution.
Maybe you misunderstood my proposal.

this markdown text:

1. First (created with `1.`)
1. Second (created with `1.`)
1. Third (created with `1.`)
1. Fourth (created with `1.`)

produce:

  1. First (created with 1.)
  2. Second (created with 1.)
  3. Third (created with 1.)
  4. Fourth (created with 1.)

same with random numbers:

1. First (created with `1.`)
11. Second (created with `11.`)
5345. Third (created with `5345.`)
5345. Fourth (created with `5345.`)
431. Fifth (created with `431.`)
  1. First (created with 1.)
  2. Second (created with 11.)
  3. Third (created with 5345.)
  4. Fourth (created with 5345.)
  5. Fifth (created with 431.)

As long as the first element in the list starts with 1. (one) and all others items on the list are like [any-number]. [user-name] everything will be fine.

Note:
this does not work:

1. First (created with `1.`)
c1. Second (created with `c1.`)
33532. Third (created with `33532.`)
3a4. Fourth (created with `3a4.`)
  1. First (created with 1.)
    c1. Second (created with c1.)
  2. Third (created with 33532.)
    3a4. Fourth (created with 3a4.)

Let me know if you like this idea.

@Roshanjossey
Copy link
Member

Oh, that's cool. I didn't know that. I learned something new today.

Still, I'm not sold on the idea. It's just, once we introduce this, most users would wanna add their entry to the end of the file. Somebody adding it in between will be confused about updating the rest of the numbers. We'll have to add more description to the tutorial that the numbering is not important and it'll render correctly. Which is a digression from what we're trying to get across.

At the end of the day, what we have in Contributors.md doesn't really matter. What matters is that our users learned the Fork -> branch -> pull request workflow. That's why I wanna keep it simple.

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

No branches or pull requests

2 participants