Skip to content

Where might implementation guides live? #292

@crertel

Description

@crertel

Problem

As a (semi-hypothetical) hopeful contributor new to the codebase, I would like to be able to add features (or work on them).

Unfortunately, learning where to make changes requires talking to people or reading a lot of code:

  • HACKING.md points at building.md, which is great but doesn't really give a rough map.
  • CONTRIBUTING.md is good for basic workflows, but doesn't really provide

Proposal

Under the maintainers directory, we have a file (HITCHHIKERS_GUIDE.md or somesuch) that gives rough locations for things that people might want to hack on ("Want to add a primop? Go here and add it, and got here and add tests.", "Want to debug how a command-line flag is handled? Go here"), etc.

Does that seem doable? Sort of a foraging guide for contributors.

Checklist

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions