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

[ENH] Refined content and location of How to access data button #409

Merged
merged 7 commits into from
Dec 20, 2024

Conversation

rmanaem
Copy link
Contributor

@rmanaem rmanaem commented Dec 19, 2024

NOTE: If this pull request is to be released, the release label must be applied once the review process is done to avoid the local and remote from going out of sync as a consequence of the bump version workflow run

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
  • If the PR changes the participant-level and/or the dataset-level result file, the query-tool-results files in the neurobagel_examples repo have been regenerated

For new features:

  • Tests have been added

For bug fixes:

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

Summary by Sourcery

Refine the content and location of the 'How to access data' button in the QueryForm component and update the corresponding test to ensure the dialog opens correctly.

Enhancements:

  • Refine the content and location of the 'How to access data' button in the QueryForm component.

Tests:

  • Add a test to ensure the 'How to access data' dialog button opens the dialog in the QueryForm component.

Copy link

sourcery-ai bot commented Dec 19, 2024

Reviewer's Guide by Sourcery

This PR refines the user interface by relocating the "How to access data" button from the results container to the query form and improving its content. The changes aim to make data access instructions more accessible and clearer to users.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Relocated the 'How to access data' button and dialog from the results container to the query form
  • Moved button state management to QueryForm component
  • Updated button text from 'How to get data' to 'How to access data'
  • Adjusted layout to position button alongside the Submit Query button
  • Removed dialog-related code from ResultContainer
src/components/QueryForm.tsx
src/components/ResultContainer.tsx
Updated the content and styling of the data access instructions dialog
  • Refined dialog title and instructions text
  • Improved clarity of steps for downloading data
  • Updated warning message about DataLad datasets
src/components/GetDataDialog.tsx
Added and updated component tests
  • Added tests for dialog visibility in QueryForm
  • Removed dialog-related tests from ResultContainer
  • Updated visibility tests for new button location
cypress/component/QueryForm.cy.tsx
cypress/component/ResultContainer.cy.tsx

Assessment against linked issues

Issue Objective Addressed Explanation
#369 Make 'How to get data' button visible at all times by relocating it
#369 Rename button to 'How to access data'
#369 Update content of the data access modal

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

netlify bot commented Dec 19, 2024

Deploy Preview for neurobagel-query ready!

Name Link
🔨 Latest commit 2e608e1
🔍 Latest deploy log https://app.netlify.com/sites/neurobagel-query/deploys/6765ae28a125aa00089e7d85
😎 Deploy Preview https://deploy-preview-409--neurobagel-query.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@rmanaem rmanaem added the pr-patch Incremental feature improvement, will increment patch version when merged (0.0.+1) label Dec 19, 2024
@surchs surchs self-requested a review December 19, 2024 21:26
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.

Thanks @rmanaem, this looks great!

I guess in the future we could also get the "download results" button to sit on the same vertical level with "submit query" and "how to get data".

Also: I think we should release off this PR already so we get the fix in #412 deployed - because I forgot to do that.

🧑‍🍳

@rmanaem
Copy link
Contributor Author

rmanaem commented Dec 20, 2024

@surchs I think it's better to release in #411 wdyt?

@surchs
Copy link
Contributor

surchs commented Dec 20, 2024

agreed

@rmanaem rmanaem merged commit fef3cb4 into main Dec 20, 2024
13 checks passed
@rmanaem rmanaem deleted the enh-369 branch December 20, 2024 19:44
Copy link
Contributor

🚀 PR was released in v0.8.1 🚀

@neurobagel-bot neurobagel-bot bot added the released This issue/pull request has been released. label Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-patch Incremental feature improvement, will increment patch version when merged (0.0.+1) released This issue/pull request has been released.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refine content and location of "How to get data" button/modal
2 participants