Skip to content

Better document the guidelines for merge/review process #1886

@DominicOram

Description

@DominicOram

We have https://diamondlightsource.github.io/dodal/main/explanations/reviews.html, which has some good documentation in it but it's very hidden in the docs. For example, a new user would probably go to https://diamondlightsource.github.io/dodal/main/how-to/contribute.html, which doesn't link to it. There's also some tidying up we could do on that page:

  • Questions and Comments talks about If you have comments for the reviewer but really the prefixes are used for if the reviewer has comments for the developer.
  • Might benefit from the terms "reviewer" and "developer" being defined more clearly
  • The document is an odd mix between "what the process is for getting work done" and "how to become an approved reviewer" this needs splitting out (also probably the title changed because of it)

Acceptance Criteria

  • Above issues are addressed and docs flow better

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions