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

[DOC] Remove usage instructions & update development environment section in README #365

Merged
merged 2 commits into from
Oct 24, 2024

Conversation

alyssadai
Copy link
Contributor

@alyssadai alyssadai commented Oct 24, 2024

  • Usage instructions removed from README to reduce repetition w/ official documentation

Checklist

This section is for the PR reviewer

  • PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF], [MODEL], [DOC]) (see our Contributing Guidelines for more info)
  • PR has a label for the release changelog or skip-release (to be applied by maintainers only)
  • PR links to GitHub issue with mention Closes #XXXX
  • Tests pass
  • Checks pass

For new features:

  • Tests have been added

For bug fixes:

  • There is at least one test that would fail under the original bug conditions.

@alyssadai alyssadai added release Create a release when this PR is merged pr-documentation Change that only affects user documentation labels Oct 24, 2024
Copy link

codecov bot commented Oct 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.37%. Comparing base (79a3ebc) to head (74e1b9a).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #365   +/-   ##
=======================================
  Coverage   98.37%   98.37%           
=======================================
  Files          16       16           
  Lines         983      983           
=======================================
  Hits          967      967           
  Misses         16       16           

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

@alyssadai alyssadai requested a review from surchs October 24, 2024 20:44
@coveralls
Copy link
Collaborator

coveralls commented Oct 24, 2024

Pull Request Test Coverage Report for Build 11507180406

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 98.372%

Totals Coverage Status
Change from base Build 11444263272: 0.0%
Covered Lines: 967
Relevant Lines: 983

💛 - Coveralls

Copy link
Contributor

@surchs surchs left a comment

Choose a reason for hiding this comment

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

🧑‍🍳

@alyssadai alyssadai merged commit 363c396 into main Oct 24, 2024
11 checks passed
@alyssadai alyssadai deleted the update-readme branch October 24, 2024 22:57
Copy link

🚀 PR was released in v0.3.0 🚀

@neurobagel-bot neurobagel-bot bot added the released This issue/pull request has been released. label Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-documentation Change that only affects user documentation release Create a release when this PR is merged released This issue/pull request has been released.
Projects
Status: Review - Done
Development

Successfully merging this pull request may close these issues.

3 participants