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

Implement preliminary tutorial screen #62

Merged
merged 7 commits into from
Mar 20, 2024
Merged

Implement preliminary tutorial screen #62

merged 7 commits into from
Mar 20, 2024

Conversation

yxu-lanl
Copy link
Collaborator

@yxu-lanl yxu-lanl commented Mar 20, 2024

Implement tutorial screen

Most of the PR titles in this repository are written in that "(Do) (thing)" format.

@eecavanna
Copy link
Collaborator

Looks good, @yxu-lanl!

The GitHub Action workflow that checks the format of the code is failing.
image

You can fix it by running the following commands locally to check the format of—and then automatically format—the code:

# Optional:
npm run format:check

# Required:
npm run format

Those commands will cause these "scripts" to run:

"format": "prettier . --write",
"format:check": "prettier . --check",

Copy link
Collaborator

@eecavanna eecavanna left a comment

Choose a reason for hiding this comment

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

I approve of this branch being merged into main after the code formatting has been fixed.

@eecavanna
Copy link
Collaborator

Also, I recommend updating the PR title to:

Implement tutorial screen

Most of the PR titles in this repository are written in that "(Do) (thing)" format.

@eecavanna eecavanna linked an issue Mar 20, 2024 that may be closed by this pull request
2 tasks
Copy link
Collaborator

@pkalita-lbl pkalita-lbl left a comment

Choose a reason for hiding this comment

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

This looks good! Other than what Eric said about the formatting, I would also add a request to use CSS Modules instead of plain CSS files. The changes here would be:

  • Rename Tutorial.css to Tutorial.module.css
  • Change the import from import "./Tutorial.css"; to import styles from "./Tutorial.module.css"
  • Change the usages of the classes from className="tutorial-header" to className={styles["tutorial-header"]}. You might also rename the CSS class itself to use camelCase (i.e. tutorialHeader) in which case you could use className={styles.tutorialHeader}.

@yxu-lanl yxu-lanl merged commit 3673c0b into main Mar 20, 2024
1 check passed
@eecavanna eecavanna changed the title #48 tutorial screen Implement preliminary tutorial screen Mar 20, 2024
@eecavanna eecavanna deleted the #48-tutorial-screen branch March 20, 2024 21:20
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.

Design and implement tutorial screens
3 participants