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

Feature: Adding contributors section to the README.md file. #2497

Open
Kalyanimhala opened this issue Oct 29, 2023 · 4 comments
Open

Feature: Adding contributors section to the README.md file. #2497

Kalyanimhala opened this issue Oct 29, 2023 · 4 comments

Comments

@Kalyanimhala
Copy link

There is no Contributors section in readme file .
As we know Contributions are what make the open-source community such an amazing place to learn, inspire, and create.
The Contributors section in a README.md file is important as it acknowledges and gives credit to those who have contributed to a project, fosters community and collaboration, adds transparency and accountability, and helps document the project's history for current and future maintainers. It also serves as a form of recognition, motivating contributors to continue their efforts.
contributors

@Kalyanimhala
Copy link
Author

@joshbressers Kindly assign me this issue, I want to work on it. Thank You!

@oswalpalash
Copy link
Member

Welp. We do have https://github.com/cloudsecurityalliance/gsd-database/blob/main/CONTRIBUTING.md

Not sure a database warrants a huge list of Contributors in the face of it with the readme. Since we do acknowledge and have links to contributors that raise new GSD data, I think that’s good enough.

Curious why you think we should have this @Kalyanimhala

@Kalyanimhala
Copy link
Author

Already mention the importance of it, in the description!
Thank You!

@oswalpalash
Copy link
Member

What I really wanted to see are counter arguments to what we already have. GitHub also has a contributors feature baked in (https://github.com/cloudsecurityalliance/gsd-database/graphs/contributors), and this just seems like not very meaningful in terms of things in the readme.
we’re likely going to have many contributors, this being a publicly available database.

Also, git already handles the transparency and accountability portion of what you indicated.

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