Skip to content

Create a Getting Started Guide for developers #260

@jodh-intel

Description

@jodh-intel

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementImprovement to an existing feature

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions