release icon indicating copy to clipboard operation
release copied to clipboard

Update CONTRIBUTING.md

Open jeremyrickard opened this issue 2 years ago • 7 comments

The CONTRIBUTING.md file in this repository is a fairly generic template. One of the questions in the 2022 annual report asked:

Does your [CONTRIBUTING.md] help new contributors engage with your group specifically by pointing to activities or programs that provide useful context or allow easy participation?

I believe we have this information in other places, but it would be beneficial to contributors to pull this into a the CONTRIBUTING.md file in order to make it more discoverable.

jeremyrickard avatar Mar 24 '23 14:03 jeremyrickard

Here are a few ideas looking at other CONTRIBUTING docs.

  • Different sections

    • Getting started (seen multiple times)
    • Mentorship
    • Before you begin
    • Your first contribution (seen multiple times)
    • Workflow
    • Issue triaging
    • Use of mentions (seen multiple times)
    • Getting in touch
    • Code reviews
    • Community guidelines
  • The kubernetes/sig-release/CONTRIBUTING.md is much more expanded. Maybe its good to reference a 'central' sig-release contributing md and expand into specific for each repo. This could help build easier context for new comers. Like me 😉

  • Interesting on SIG-cli (here) a "Pick your track". Guiding the user for different ways of CONTRIBUTING.

  • SIG-cli has more interesting subsections that help the contributor.

  • The community/sig-release is missing a CONTRIBUTING.md. This might be the place where people go when they are first interested in the SIG.

matglas avatar Apr 18 '23 12:04 matglas

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle stale
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot avatar Jul 17 '23 13:07 k8s-triage-robot

/remove-lifecycle stale

vaibhav2107 avatar Aug 02 '23 04:08 vaibhav2107

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle stale
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot avatar Jan 25 '24 16:01 k8s-triage-robot

/remove-lifecycle stale

xmudrii avatar Jan 25 '24 16:01 xmudrii

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle stale
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot avatar Apr 24 '24 16:04 k8s-triage-robot

/lifecycle frozen

xmudrii avatar Apr 25 '24 09:04 xmudrii