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

initial linting and testing set up #3

Merged
merged 3 commits into from
Oct 18, 2024
Merged

initial linting and testing set up #3

merged 3 commits into from
Oct 18, 2024

Conversation

jennymar
Copy link
Collaborator

@jennymar jennymar commented Oct 16, 2024

Info

Closes #2

Description

What changes did you make? List all distinct problems that this PR addresses. Explain any relevant
motivation or context.

This PR adds basic linting and testing as well as has them run on creation of PR against the main branch.

Changes

Linting:

  • added linting scripts
    Testing:
  • set up Jest (added it as a dependency, added jest.config.json, added script)
  • created a few dummy tests in sample.test.ts

Type of Change

  • Patch (non-breaking change/bugfix)
  • Minor (non-breaking change which adds functionality)
  • Major (fix or feature that would cause existing functionality to not work as
    expected)
  • Documentation (A change to a README/description)
  • Continuous Integration/DevOps Change (Related to deployment steps, continuous integration
    workflows, linting, etc.)
  • Other: (Fill In)

If you've selected Patch, Minor, or Major as your change type, make sure to bump the version before merging in package.json!

Testing

I have tested that my changes fully resolve the linked issue ...

  • locally.
  • on the testing API/testing database.
  • with appropriate Postman routes. Screenshots are included below.

Checklist

  • I have performed a self-review of my own code.
  • I have followed the style guidelines of this project.
  • I have appropriately edited the API version in the package.json file.
  • My changes produce no new warnings.

Screenshots

Please include a screenshot of your Postman testing passing successfully.

@jennymar jennymar requested a review from echang594 as a code owner October 16, 2024 18:21
Copy link

Thanks for contributing!
If you've made changes to the API's functionality, please make sure to bump the package
version—see this guide to semantic versioning for details—and
document those changes as appropriate.

Copy link
Collaborator

@echang594 echang594 left a comment

Choose a reason for hiding this comment

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

Just small nitpicks, looks good otherwise. We can add the docker stuff in a new PR.

- name: Set up Node.js
uses: actions/setup-node@v2
with:
node-version: '18'
Copy link
Collaborator

Choose a reason for hiding this comment

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

Don't think this will cause any issues but we are using node version lts/iron (currently 20.18.0).

- name: Set up Node.js
uses: actions/setup-node@v2
with:
node-version: '18'
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same as above

Copy link
Collaborator

@echang594 echang594 left a comment

Choose a reason for hiding this comment

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

Looks good to me 👍

@jennymar jennymar merged commit 5f2382d into main Oct 18, 2024
4 checks passed
@echang594 echang594 linked an issue Oct 18, 2024 that may be closed by this pull request
@echang594 echang594 deleted the ci-setup branch October 18, 2024 02:46
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.

Setup CI for linting and unit tests
2 participants