-
Notifications
You must be signed in to change notification settings - Fork 172
Bump Node.js to version 20, update documentation #2712
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
Merged
Merged
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
9a1343a
Create .node-version file
RichDom2185 3a59b92
Add selective WebGL dependency resolution
RichDom2185 bdd3142
Bump node version in CI workflows
RichDom2185 f656892
Fix missing dependencies in CI workflow
RichDom2185 c21e1c5
Update CD workflow
RichDom2185 22d0301
Fix typo in CLI option
RichDom2185 716bc6d
Fix insufficient permissions
RichDom2185 1e0abfe
Update actions to v4
RichDom2185 6e12fef
Fix resolution warning
RichDom2185 ec702c1
Reorganize documentation
RichDom2185 240645b
Update and simplify README instructions
RichDom2185 426b6f0
Add Python 3.11 disclaimer
RichDom2185 f71b145
Merge branch 'master' into node-20
RichDom2185 3ba05e3
Merge branch 'master' into node-20
RichDom2185 47ef0e2
Merge branch 'master' into node-20
RichDom2185 8f480dc
Merge branch 'master' into node-20
RichDom2185 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
20.9.0 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Contributing Guide | ||
|
||
Refer to our issue tracker and contribute to any open issues you are able to spot there. If you have any new issues, please do post there as well. We welcome any form of contribution and are open to any new ideas you may have for the project! | ||
|
||
To start contributing, create a fork from our repo and send a PR. Refer to [this article](https://help.github.com/en/articles/fork-a-repo) for more information. | ||
|
||
## Application Structure | ||
|
||
1. `assets` contains static assets. | ||
1. `commons` contains components or other code common to more than one page. | ||
1. `features` contains action creators, reducers and type declarations for specific functions. | ||
1. `pages` contains pages and components used only in one page; its layout should mirror the actual routes. | ||
1. `styles` contains all SCSS styles. | ||
|
||
## Testing | ||
|
||
The frontend comes with an extensive test suite. To run the tests after you made your modifications, run | ||
`yarn test`. Regression tests are run automatically when you want to push changes to this repository. | ||
The regression tests are generated using `jest` and stored as snapshots in `src/\_\_tests\_\_`. After modifying the frontend, carefully inspect any failing regression tests reported in red in the command line. If you are convinced that the regression tests and not your changes are at fault, you can update the regression tests by running: | ||
|
||
```bash | ||
yarn test --updateSnapshot | ||
``` | ||
|
||
## Manually testing the frontend | ||
|
||
Before pushing to Github, ensure that your code is formatted and your tests are passing. These two commands should help with that: | ||
|
||
- `yarn run format` : formats your code | ||
- `yarn run test`: runs the tests and prints the output | ||
|
||
## Running your own js-slang | ||
|
||
See [js-slang README](https://github.com/source-academy/js-slang#using-your-js-slang-in-local-source-academy) for instructions how to run your own js-slang in the frontend. | ||
|
||
## TypeScript Coding Conventions | ||
|
||
We reference [this guide](https://github.com/piotrwitek/react-redux-typescript-guide). | ||
|
||
See also the [this standard in the wiki](https://github.com/source-academy/frontend/wiki/Coding-Standard). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
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.
is there a reason for removing the build cache here?
looks good otherwise (M2 MBA Sonoma, Node 20.9.0, Python 3.9)
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.
Using
in
actions/setup-node
handles this caching for us. We no longer need to manually set up caching of certain files/folders anymore.