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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add format description on how to add your name to Contributors.md #1828

Closed
tinoromero opened this issue Dec 19, 2017 · 3 comments
Closed

Add format description on how to add your name to Contributors.md #1828

tinoromero opened this issue Dec 19, 2017 · 3 comments

Comments

@tinoromero
Copy link

馃悶 Problem
When adding my name, I noticed that other people's name were not written properly, which led to:

  • name not being displayed when viewing the document (when adding a space before the hyphen)
  • name with extra characters (when adding brackets and no giuthub url)
  • name not being linked to github url (when adding a space between the name and the url)

馃幆 Goal
To have a better formatted Contributors list.

馃挕 Possible solutions
Add a description, with examples, on how to properly add your name to Contributors.md in the README.md file.

馃搵 Steps to solve the problem
Add description to README.md file.

Kyle-Pu added a commit to Kyle-Pu/first-contributions that referenced this issue Jan 2, 2018
Added a description of how to properly format name in order to correctly display name as well as link to profile. Closes firstcontributions#1828
@Kyle-Pu Kyle-Pu mentioned this issue Jan 2, 2018
Roshanjossey added a commit that referenced this issue Jan 24, 2018
Solved similar problem according to issue #1828
@Roshanjossey
Copy link
Member

Hi @juventinoromero, we're thinking about not addressing this issue. The following are my thoughts on this

  • What's most important for us is that users should be able to make their first pull request. What change they make is not of really important. Adding name to contributors list is just a good suggestion.
  • Most of our emphasis should be on pull request workflow. Things specific to this project should be kept to minimum
  • What's in contributors file is not very important.

Do share your thoughts on these

@tinoromero
Copy link
Author

Hi @Roshanjossey! I agree with all you've said, it doesn't add anything to the new contributor's experience. I created this issue mainly because I wanted to learn how to do it and because this repo is sort of a playground for new contributors. But you麓re totally right: the simpler, the better.

@Roshanjossey
Copy link
Member

@juventinoromero, I'm so happy that you understand the gist of this project.

I created this issue mainly because I wanted to learn how to do it and because this repo is sort of a playground for new contributors.

You're absolutely right.

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