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

Add section on code review to deployment process docs. #1214

Merged
merged 6 commits into from
Feb 4, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/deployment-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,25 @@ cloud.gov UAA application for its users.
Tock uses the cloud.gov service account service to provide deployer accounts for
staging and production environments.

### Code review

Submissions to the Tock codebase are made via GitHub, and are only accepted into the main
branch after review. At least one approving review is required before a branch is merged
to main, and this restriction is enforced by Tock's GitHub settings.
tadhg-ohiggins marked this conversation as resolved.
Show resolved Hide resolved
Your reviewer will usually merge the branch for you.

Code review covers both code (such as Python or JavaScript) and configuration (such as
Dockerfiles, CloudFoundry manifest files, etc.).

Code reviews should be conducted [following the 18F Engineering Guide](https://engineering.18f.gov/code-review/) and include an assessment of:

- Simplicity. Ideally the submission implements the feature/fix with as little complexity as possible.
- Legibility. Ideally the submission is easy to understand.
- Security. The submission is reviewed for security considerations.

Code review is in addition to the various automated checks, which include tests, linting,
and checks on security flaws of Tock's dependencies.

### CircleCI continuous integration, delivery, and deployment

Tock uses CircleCI to continuously integrate code, deliver the code to staging
Expand Down