cncf / mentoring

👩🏿‍🎓👨🏽‍🎓👩🏻‍🎓CNCF Mentoring: LFX Mentorship + Summer of Code
https://mentoring.cncf.io
Apache License 2.0
2.37k stars 612 forks source link

Addition of Markdown for Contribution Guidelines #1073

Closed Debaditya-Som closed 1 year ago

Debaditya-Som commented 1 year ago

Description: As part of creating a welcoming and collaborative environment within the open-source community, I propose adding a markdown file that outlines the contribution guidelines for our project. This document will serve as a reference point for new contributors and help streamline the contribution process.

Desired Outcome:

Why is this Important:

Proposed Implementation:

  1. Fork the repository.
  2. Create a CONTRIBUTING_GUIDELINES.md markdown file in the root directory.
  3. Populate the file with relevant content, adhering to best practices for markdown formatting.
  4. Create a pull request to merge the changes into the main repository.

Additional Information:

Impact: By implementing this addition, we can facilitate a more inclusive and streamlined contribution process for our open-source project.

Contributor Expectations: Contributors, maintainers, and community members are encouraged to share their insights and suggestions regarding the proposed contribution guidelines.

nate-double-u commented 1 year ago

Hi @Debaditya-Som,

I'm a little confused by this issue. While I agree there isn't a CONTRIBUTING_GUIDELINES.md file, this isn't a typical development repository. This repo is used to help us run the CNCF mentorship programs, and does have quite a bit of information about how project maintainers can propose project ideas, and how mentees can apply to the programs that we support.

Rather than suggesting a contributing guidelines file, I'd like to invite you to make specific suggestions about the participation guides that we have.