-
Notifications
You must be signed in to change notification settings - Fork 0
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
Conversation
yxu-lanl
commented
Mar 20, 2024
•
edited
Loading
edited
…proach Demonstrate "Markdown-in-JS" approach (using `react-markdown`)
Looks good, @yxu-lanl! The GitHub Action workflow that checks the format of the code is failing. 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: Lines 9 to 10 in 227d993
|
There was a problem hiding this 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.
Also, I recommend updating the PR title to:
|
There was a problem hiding this 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
toTutorial.module.css
- Change the import from
import "./Tutorial.css";
toimport styles from "./Tutorial.module.css"
- Change the usages of the classes from
className="tutorial-header"
toclassName={styles["tutorial-header"]}
. You might also rename the CSS class itself to use camelCase (i.e.tutorialHeader
) in which case you could useclassName={styles.tutorialHeader}
.