Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor Developer Practices documentation #2870

Open
3 tasks
erinysong opened this issue Sep 30, 2024 · 0 comments
Open
3 tasks

Refactor Developer Practices documentation #2870

erinysong opened this issue Sep 30, 2024 · 0 comments
Labels
story User stories

Comments

@erinysong
Copy link
Contributor

erinysong commented Sep 30, 2024

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.

Acceptance Criteria

  • Update dev-practices folder to add docs for relevant engineering practices on .gov project. Think of what engineering practices would be useful to someone first onboarding onto .gov. Possible examples include (but may not necessarily): PR reviews, naming conventions, testing conventions, scripts, USWDS and front-end overrides.
  • Remove outdated information in engineering standards docs (mainly thinking of Contributing.md and our scripts docs).
  • Present updated dev-practices docs at engineering huddle for team review.

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 be inferred by just looking at our codebase.

Possible References

Issue Links

No response

@erinysong erinysong added the story User stories label Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
story User stories
Projects
Status: 👶 New
Development

No branches or pull requests

1 participant