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] Added warning about quoting in .env file for Docker commands #284

Merged
merged 3 commits into from
Mar 7, 2024
Merged

[DOC] Added warning about quoting in .env file for Docker commands #284

merged 3 commits into from
Mar 7, 2024

Conversation

samadpls
Copy link
Contributor

@samadpls samadpls commented Mar 2, 2024

Changes proposed in this pull request:

  • Added warning about quoting in .env file for Docker commands

Checklist

  • PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF], [MODEL], [DOC]) (see https://neurobagel.org/contributing/pull_requests 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 self-requested a review March 7, 2024 18:03
@alyssadai alyssadai added the pr-documentation Change that only affects user documentation label Mar 7, 2024
Copy link
Contributor

@alyssadai alyssadai left a comment

Choose a reason for hiding this comment

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

Thanks a lot for addressing this @samadpls, and for the nice formatting of the warnings! 😄

A minor phrasing suggestion below for clarity (I think it's always helpful to link to existing issues where possible). Otherwise, this should be good to merge! 🧑‍🍳

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
samadpls and others added 2 commits March 8, 2024 00:30
Co-authored-by: Alyssa Dai <[email protected]>
Co-authored-by: Alyssa Dai <[email protected]>
@samadpls samadpls requested a review from alyssadai March 7, 2024 19:30
@alyssadai alyssadai merged commit 4ade1eb into neurobagel:main Mar 7, 2024
4 checks passed
@coveralls
Copy link
Collaborator

coveralls commented Mar 7, 2024

Pull Request Test Coverage Report for Build 8193763974

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

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 99.785%

Totals Coverage Status
Change from base Build 8089977516: 0.0%
Covered Lines: 929
Relevant Lines: 931

💛 - Coveralls

@surchs
Copy link
Contributor

surchs commented Apr 11, 2024

🚀 PR was released in v0.2.0 🚀

@surchs surchs added the released This issue/pull request has been released. label Apr 11, 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 released This issue/pull request has been released.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Warn about quotes interpretation in README instructions for using API docker image directly
4 participants