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

chore: Update Dev Docs #1104

Merged
merged 26 commits into from
Sep 23, 2024
Merged

chore: Update Dev Docs #1104

merged 26 commits into from
Sep 23, 2024

Conversation

rainandbare
Copy link
Contributor

@rainandbare rainandbare commented Sep 16, 2024

ticket: https://czi.atlassian.net/browse/SCE-11

Mostly formatting changes. All the information was here when I tried to set up my environment the first time.
I added a brief explanation of activation a Virtual Environment but that might be overkill.

Comment on lines -31 to -34
### Release

See `release_process.md`.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This file doesn't exist.


## How to run tests

Client and server tests run on [Github Actions](https://github.com/chanzuckerberg/single-cell-explorer/actions/workflows/push_tests.yml) for every push, PR, and commit to `main` on Github. Smoke tests are run upon every dev deployment which occurs automatically every time a PR merged into `main`.

### Environment
Copy link
Contributor Author

Choose a reason for hiding this comment

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

moved from above

Copy link

codecov bot commented Sep 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.60%. Comparing base (0d204de) to head (6706ce5).
Report is 131 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1104      +/-   ##
==========================================
+ Coverage   77.47%   77.60%   +0.12%     
==========================================
  Files          88       92       +4     
  Lines        6856     7162     +306     
==========================================
+ Hits         5312     5558     +246     
- Misses       1544     1604      +60     
Flag Coverage Δ
frontend 77.60% <ø> (+0.12%) ⬆️
javascript 77.60% <ø> (+0.12%) ⬆️
smokeTest ?
unitTest 77.60% <ø> (+0.12%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@tihuan tihuan left a comment

Choose a reason for hiding this comment

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

Thanks so much for the audit and improvement, @rainandbare !! LGTM ✨ 👏 !!

@rainandbare rainandbare merged commit a891910 into main Sep 23, 2024
29 checks passed
@rainandbare rainandbare deleted the rainandbare/update-dev-docs branch September 23, 2024 20:28
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.

3 participants