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

Create a Getting Started Guide for developers #260

Open
jodh-intel opened this issue Mar 11, 2022 · 1 comment
Open

Create a Getting Started Guide for developers #260

jodh-intel opened this issue Mar 11, 2022 · 1 comment
Labels
enhancement Improvement to an existing feature

Comments

@jodh-intel
Copy link
Contributor

Problem

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

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 😄

Plan

  • Get ideas for what sort of info to include.
  • If folk agree, we could hack^Wdraft this in the wiki.
@jodh-intel jodh-intel added the enhancement Improvement to an existing feature label Mar 11, 2022
@cmaf
Copy link

cmaf commented Aug 4, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvement to an existing feature
Projects
None yet
Development

No branches or pull requests

2 participants