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 #47

Merged
merged 1 commit into from
Feb 2, 2021
Merged

Update README.md #47

merged 1 commit into from
Feb 2, 2021

Conversation

rstens
Copy link
Member

@rstens rstens commented Feb 2, 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)
  • 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
  • My code follows the style guidelines of this project
  • New and existing unit tests pass locally with my changes

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 and inform future developers

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

Tests

  • I have added/updated unit tests for any new code I've added/updated
  • I have added/updated Postman tests to account for any new/updated code

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.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Feb 2, 2021

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@codecov
Copy link

codecov bot commented Feb 2, 2021

Codecov Report

Merging #47 (d461133) into dev (89a1f73) will increase coverage by 4.66%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##              dev      #47      +/-   ##
==========================================
+ Coverage   12.90%   17.57%   +4.66%     
==========================================
  Files          34       77      +43     
  Lines         519      899     +380     
  Branches      113      182      +69     
==========================================
+ Hits           67      158      +91     
- Misses        450      736     +286     
- Partials        2        5       +3     
Impacted Files Coverage Δ
app/src/rjsf/templates/FieldTemplate.tsx 14.28% <0.00%> (ø)
app/src/features/projects/EditProjectPage.tsx 7.69% <0.00%> (ø)
app/src/features/home/HomeRouter.tsx 0.00% <0.00%> (ø)
app/src/rjsf/components/AddButton.tsx 50.00% <0.00%> (ø)
app/src/App.tsx 50.00% <0.00%> (ø)
app/src/components/layout/Header.tsx 50.00% <0.00%> (ø)
app/src/hooks/useBioHubApi.ts 61.53% <0.00%> (ø)
app/src/features/projects/ProjectsPage.tsx 60.71% <0.00%> (ø)
app/src/rjsf/templates/ObjectFieldTemplate.tsx 17.64% <0.00%> (ø)
app/src/constants/temp_demo.ts 100.00% <0.00%> (ø)
... and 33 more

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 89a1f73...d461133. Read the comment docs.

@rstens rstens merged commit cfce40f into dev Feb 2, 2021
@rstens rstens deleted the Dummy-patch-to-trigger-work-flow branch February 2, 2021 23:53
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