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

Typos (Extra spaces and/or Issues with bullets) in Contributors.md #38651

Closed
chincholikarsalil opened this issue Apr 26, 2021 · 7 comments
Closed

Comments

@chincholikarsalil
Copy link

chincholikarsalil commented Apr 26, 2021

Typos (Extra spaces and/or Issues with bullets) in Contributors.md

🐞 Problem

  • There are a lot of typos in the Contributors file.

🎯 Goal

  • To clean the file and make its structure better

💡 Possible solutions

  • While adding your details to the file before creating your pull request, use this format:

- [Your-Name](https://github.com/your-username)

📋 Steps to solve the problem

  • Try to find and solve more problems in the file.
@chincholikarsalil chincholikarsalil changed the title Typos (Extra spaces and/or Issues will bullets) in Contributors.md Typos (Extra spaces and/or Issues with bullets) in Contributors.md Apr 26, 2021
@Coolshreshtha
Copy link

I fixed some issues that were easier to batch together. But other problems like angular brackets without a link are more time consuming. Is there a better way to manage entries and formatting in the file rather than just brute force?

@chincholikarsalil
Copy link
Author

Checkout the PR that I have attached.

@chincholikarsalil
Copy link
Author

I think we can write a python script, but as you said, not everybody follows the proper way. I'm not sure, but can we use lint? @Coolshreshtha

@Coolshreshtha
Copy link

I'm not familiar with lint. Maybe others can speak more to that?

@emekasage
Copy link

emekasage commented May 10, 2021

Yes, I think lint would be best. Also, feel it should be specified in the README.md file the format contributors should use when adding their names. for example, " - ([your-name])((your-github-url)) "

@emekasage
Copy link

I've just added a format in which contributors should add their names in the README.md file and also created a pull request. Hopefully, it gets aproved.

@chincholikarsalil
Copy link
Author

@emekasage look at the changes in #38649
Can you suggest how to use lint here to avoid this manual work?

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

Successfully merging a pull request may close this issue.

5 participants
@Roshanjossey @chincholikarsalil @emekasage @Coolshreshtha and others