community icon indicating copy to clipboard operation
community copied to clipboard

Create a Getting Started Guide for developers

Open jodh-intel opened this issue 3 years ago • 1 comments

Problem

We have a contributing guide but it is scarily large and dense and could be viewed as slightly intimidating:

  • https://github.com/kata-containers/community/blob/main/CONTRIBUTING.md

Idea

We could just fix the problem, but that will result in an even larger contributing guide, which is part of the problem.

Hence, I'm wondering if it makes sense to create a "getting started guide for developers" that would:

  • Guide a developer through the process of raising their first PR.
  • Point out pitfalls to avoid.
  • Provide advice.
  • Be generally less scary :smile:

Plan

  • Get ideas for what sort of info to include.
  • If folk agree, we could hack^Wdraft this in the wiki.

jodh-intel avatar Mar 11 '22 18:03 jodh-intel

@jodh-intel this is a good idea. In general the contributing guide needs to be reviewed & updated as well

cmaf avatar Aug 04 '22 22:08 cmaf