Skip to content

Conversation

bweick
Copy link
Contributor

@bweick bweick commented Nov 24, 2021

Code Review Processes

New Feature Review

Before submitting a pull request for new review, make sure the following is done:

  • Design doc is created and posted here: [Insert Link]
  • Code cleanliness and completeness is addressed via guidelines

README Checks

  • [] README has proper context for the reviewer to understand what the code includes, any important design considerations, and areas to pay more attention to

Code Checks

  • [] Add explanatory comments. If there is complex code that requires specific context or understanding, note that in a comment
  • [] Remove unncessary comments. Any comments that do not add additional context, information, etc. should be removed
  • [] Add javadocs.
  • [] Scrub through the code for inconsistencies (e.g. removing extra spaces)
  • [] Ensure there are not any .onlys in spec files

Broader Considerations

  • [] Ensure variable, function and event naming is clear, consistent, and reflective for the scope of the code.
  • [] Consider if certain pieces of logic should be placed in a different library, module

@bweick bweick changed the base branch from master to chris_sachin/perpv2_module_draft November 24, 2021 19:53
@bweick bweick merged commit cc38f39 into chris_sachin/perpv2_module_draft Nov 24, 2021
@bweick bweick deleted the brian/add-events branch November 24, 2021 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant