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

Update README.md #608

Merged
merged 1 commit into from
Oct 19, 2021
Merged

Update README.md #608

merged 1 commit into from
Oct 19, 2021

Conversation

rstens
Copy link
Member

@rstens rstens commented Oct 19, 2021

Overview

Links to jira tickets

  • {Include links to all of the applicable Jira tickets}

This PR contains the following changes

  • {List all the relevant changes. If there are many changes across many Jira tickets, organize the changes by Jira ticket}

This PR contains the following types of changes

  • New feature (change which adds functionality)
  • Enhancement (improvements to existing functionality)
  • Bug fix (change which fixes an issue)
  • Misc cleanup / Refactoring / Documentation
  • Version change

Checklist

A list of items that are good to consider when making any changes.

Note: this list is not exhaustive, and not all items are always applicable.

General

  • I have performed a self-review of my own code

Code

  • New files/classes/functions have appropriately descriptive names and comment blocks to describe their use/behaviour
  • I have avoided duplicating code when possible, moving re-usable pieces into functions
  • I have avoided hard-coding values where possible and moved any re-usable constants to a constants file
  • My code is as flat as possible (avoids deeply nested if/else blocks, promise chains, etc)
  • My code changes account for null/undefined values and handle errors appropriately
  • My code uses types/interfaces to help describe values/parameters/etc, help ensure type safety, and improve readability

Style

  • My code follows the established style conventions
  • My code uses native material-ui components/icons/conventions when possible

Documentation

  • I have commented my code sufficiently, such that an unfamiliar developer could understand my code
  • I have added/updated README's and related documentation, as needed

Tests

  • I have added/updated unit tests for any code I've added/updated
  • I have added/updated the Postman requests/tests to account for any API endpoints I've added/updated

Linting/Formatting

  • I have run the linter and fixed any issues, as needed
    See the lint commands in package.json
  • I have run the formatter and fixed any issues, as needed
    See the format commands in package.json

SonarCloud

  • I have addressed all SonarCloud Bugs, Vulnerabilities, Security Hotspots, and Code Smells

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.

Screenshots

Please add any relevant UI screenshots, if applicable.

@codecov
Copy link

codecov bot commented Oct 19, 2021

Codecov Report

Merging #608 (9932907) into test (48d5c11) will increase coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             test     #608   +/-   ##
=======================================
  Coverage   76.70%   76.71%           
=======================================
  Files         287      287           
  Lines       10281    10281           
  Branches     2150     2150           
=======================================
+ Hits         7886     7887    +1     
+ Misses       2063     2062    -1     
  Partials      332      332           
Impacted Files Coverage Δ
app/src/hooks/api/useExternalApi.ts 100.00% <0.00%> (+12.50%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 48d5c11...9932907. Read the comment docs.

@rstens rstens merged commit b56952f into test Oct 19, 2021
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