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.

Sign up for GitHub

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

Jump to bottom

Write an introduction to code reviews explaining how to make the best of a code review #4

Closed
wants to merge 12 commits into from
Closed

Write an introduction to code reviews explaining how to make the best of a code review #4

wants to merge 12 commits into from

Conversation

cloudappsguy
Copy link

@cloudappsguy cloudappsguy commented Nov 17, 2023 •
edited by skyarkitekten

Description

This PR adds new content to further enhance and describe the purpose and approach to code reviews.

PR Checklist

Use the check-list below to ensure your branch is ready for PR. If the item is not applicable, leave it blank.

  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • My code follows the code style of this project.
  • I ran the lint checks which produced no new errors nor warnings for my changes.
  • I have checked to ensure there aren't other open Pull Requests for the same update/change.

Does this introduce a breaking change?

  • Yes
  • No

Any relevant logs or outputs

N/A

Other information or known dependencies

N/A

@cloudappsguy
initial content additions:
895a67a 
New content for review effectiveness including a sample agenda and sample Outlook meeting template.

Updated Readme content to reflect newly added review content.
@cloudappsguy
updated links
fdbbfae 
added sample agenda md link to readme
fixed link to agenda oft in sample agenda
@cloudappsguy
updated agenda email template file type
c2f0933 
Changed from OFT to TXT file type
Updated file path reference links
@cloudappsguy
updated content
adf753c 
Added details on psychological safety, updated link order in resources
@cloudappsguy
Added common issues
a7b44ed 
Added new content for common issues discovered during code reviews;
Updated Readme content and resource links;
Updated sentence structure for review agenda link.
@cloudappsguy
Added reference to SOLID principles further details
981d736
@cloudappsguy
removed non-related PR content
481582a
@cloudappsguy
removed non-related PR content
835b22f
@cloudappsguy cloudappsguy linked an issue Nov 17, 2023 that may be closed by this pull request
Create an introduction to Code Reviews explaining how to make the best of a code review #3
Open
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 17, 2023 •
edited

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ ACTION actionlint 2 0 0.02s
✅ MARKDOWN markdownlint 247 0 5.91s
✅ MARKDOWN markdown-table-formatter 247 0 0.57s
✅ MDLINKCHECK linkcheck 247 0 11.4s
✅ SPELL cspell 258 0 11.84s
✅ YAML prettier 10 0 1.45s
✅ YAML yamllint 10 0 0.52s

See detailed report in MegaLinter reports

You could have same capabilities but better runtime performances if you request a new MegaLinter flavor.

MegaLinter is graciously provided by OX Security

skyarkitekten
skyarkitekten previously approved these changes Nov 18, 2023
View reviewed changes
Copy link

@skyarkitekten skyarkitekten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left some comments, no pressing changings

@chadcook chadcook self-assigned this Nov 22, 2023
chadcook
chadcook previously approved these changes Nov 22, 2023
View reviewed changes
@cloudappsguy
Update README.md
2e722b5 
verbiage change from essential to required per Cook's suggestion.

Signed-off-by: Josh Nelson <11245067+cloudappsguy@users.noreply.github.com>
@cloudappsguy cloudappsguy mentioned this pull request Dec 1, 2023
Open
skyarkitekten
skyarkitekten approved these changes Jan 18, 2024
View reviewed changes
Copy link

@skyarkitekten skyarkitekten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed, comments closed, ready for merge.

@skyarkitekten skyarkitekten deleted the 3-create-an-introduction-to-code-reviews-explaining-how-to-make-the-best-of-a-code-review branch January 20, 2024 20:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@skyarkitekten skyarkitekten skyarkitekten approved these changes

@chadcook chadcook chadcook left review comments

@mikeholdorf mikeholdorf Awaiting requested review from mikeholdorf mikeholdorf is a code owner

Assignees

@skyarkitekten skyarkitekten

@chadcook chadcook

@cloudappsguy cloudappsguy

@mikeholdorf mikeholdorf

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create an introduction to Code Reviews explaining how to make the best of a code review
4 participants
@cloudappsguy @skyarkitekten @chadcook @mikeholdorf