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 code review documentation #791

Merged
merged 2 commits into from
Feb 12, 2024
Merged

Add code review documentation #791

merged 2 commits into from
Feb 12, 2024

Conversation

ccostino
Copy link
Contributor

@ccostino ccostino commented Feb 5, 2024

This changeset adds documentation for what to expect and how to conduct and receive code reviews. We want to improve our team practices and ensure that all members know how to engage and what to expect with code reviews. Furthermore, this can serve as another model and positive example of how to collaborate as a team in the broader open source community.

Security Considerations

  • The documentation makes explicit mention of looking for security compliance concerns and documentation in future pull requests and code/system changes.

@ccostino ccostino added documentation Improvements or additions to documentation engineering labels Feb 5, 2024
@ccostino ccostino requested a review from stvnrlly February 5, 2024 17:45
@ccostino ccostino self-assigned this Feb 5, 2024
This changeset adds documentation for what to expect and how to conduct and receive code reviews.  We want to improve our team practices and ensure that all members know how to engage and what to expect with code reviews.  Furthermore, this can serve as another model and positive example of how to collaborate as a team in the broader open source community.

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
h/t to @stvnrlly for the suggestion!

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
@stvnrlly stvnrlly merged commit 2f5fea6 into main Feb 12, 2024
5 checks passed
@stvnrlly stvnrlly deleted the add-code-review-doc-info branch February 12, 2024 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation engineering
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants