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 Testing, Static Analysis, Code Formatting #814

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Add Testing, Static Analysis, Code Formatting #814

wants to merge 7 commits into from

Conversation

jmadler
Copy link
Contributor

@jmadler jmadler commented Aug 31, 2022

Description

One Line Summary

Adding testing static analysis and code formatting for the Qualityathon

Details

Motivation

Testing, static analysis and code formatting as part of git actions and precommit hooks will improve the quality of the code that gets pulled into the project.

Scope

Testing will be done with Jest
Static Analysis will be done with eslint
Formatting will be done with prettier

Affected code checklist

  • Testing, static analysis and code formatting as part of git actions and precommit hooks will improve the quality of the code that gets pulled into the project.

Checklist

Overview

  • I have filled out all REQUIRED sections above
  • PR does one thing
    • If it is hard to explain how any codes changes are related to each other then it most likely needs to be more than one PR
  • Any Public API changes are explained in the PR details and conform to existing APIs

Testing

  • I have included test coverage for these changes, or explained why they are not needed
  • All automated tests pass, or I explained why that is not possible
  • I have personally tested this on my device, or explained why that is not possible

Final pass

  • Code is as readable as possible.
    • Simplify with less code, followed by splitting up code into well named functions and variables, followed by adding comments to the code.
  • I have reviewed this PR myself, ensuring it meets each checklist item
    • WIP (Work In Progress) is ok, but explain what is still in progress and what you would like feedback on. Start the PR title with "WIP" to indicate this.

This change is Reviewable

@jmadler jmadler requested review from rgomezp and nan-li September 7, 2022 19:30
pushToken : string;
emailUserId : string;
emailAddress : string;
smsUserId : string;
Copy link
Contributor

Choose a reason for hiding this comment

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

I do like the readability when a long list of properties is spaced out like this.

@rgomezp rgomezp removed their request for review October 6, 2023 17:01
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.

2 participants