Skip to content

Write contributor docs for the modern engineering workflow #20

@GuiBibeau

Description

@GuiBibeau

User Story

As a maintainer, I want contributor documentation for the modern engineering workflow so that new fellows can onboard quickly and work in the same way.

Context

Tooling only helps if contributors know how to use it. This issue should consolidate the expected modern workflow around React development, testing, CI, and pull requests.

Acceptance Criteria

  • The repo documents the local development workflow clearly
  • The docs explain how to run lint, typecheck, unit tests, and any E2E tests
  • The docs explain how CI and preview environments work
  • The docs explain expected pull request hygiene and debugging basics
  • The onboarding guide is written for junior engineers, not just senior contributors

Notes

  • This should be practical and concrete, not abstract process writing
  • Assume contributors are smart but new to the stack
  • Good documentation here will save repeated onboarding time later

Out of Scope

  • Feature specs
  • Full architecture decision records for every tool

Size

Medium

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:devexDeveloper experience, tooling, and contributor workflowdocumentationImprovements or additions to documentationenhancementNew feature or requestfellowshipSpring 2026 fellowship project workphase:1-foundationFoundation and engineering baseline

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions