Skip to content

Proposal: Developer/Contributor Docs #1819

@dnephin

Description

@dnephin

Originally requested in #1811 (comment)

Currently there are the following docs:

  • CONTRIBUTING.md - documents the github contribution process (PR process, git commit, etc)
  • README.md "Developer Quick-Start" - some basics about how to setup an environment to build binaries, run tests, and other perform other "project tasks"
  • BUILDING.md - a more complete version of the "Developer Quick-Start"

Documentation duplication is almost as bad as code duplication. It's already a challenge to keep one document up to date.

Proposal

Keep CONTRIBUTING.md as-is, but reference it from the developer docs.

Remove "Developer Quick-Start" from the README.md, and replace it with a section called (something like) "Developer Guide". This section should be just a link to BUILDING.md, no details.

Update BUILDING.md:

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions