cisagov / manage.get.gov

A Django-based domain name registrar that interfaces with an EPP registry
https://get.gov
Other
60 stars 18 forks source link

Refactor our developer practices documentation #2870

Open erinysong opened 1 month ago

erinysong commented 1 month ago

Story

As a developer, I want to easily reference (and update as needed) development practices for our project, so I can follow best development practices and our project maintains consistent code quality.

On 9/30's engineering huddle, we decided to consolidate team practices into a dev-practices folder. Currently this folder includes code-review.md which includes PR best practices that we moved from our PR template in https://github.com/cisagov/manage.get.gov/issues/2140. Since code-review.md also includes coding best practices from our PR template, our 2 viable options are:

  1. Turn code-review.md into a general dev standards page (example: CCAO data handbook.md) which has a PR review section and coding standards section.
  2. Split code-review.md into code-review.md with PR practices and code-standards.md

Acceptance Criteria

Additional Context

Engineering Huddle Notes

Engineering standards library - Our engineering practices are spread out across separate docs (PR review template, accessibility, contributing.md in our repo) that we can just put in one place. We can collect our engineering standards into one library/handbook, especially so people who onboard can more easily reference how to do things.

The idea is to have a living doc of engineering practices that cannot (easily) be inferred by simply looking at our codebase.

Possible References Our engineering standards library does not necessarily have to be as complex as these examples if that's what fits our needs.

Issue Links

No response

h-m-f-t commented 1 month ago

This is a really lovely issue, @erinysong.