-
Notifications
You must be signed in to change notification settings - Fork 3
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
Move scratch-asset-types to Github Actions #16
Merged
Merged
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
a22ca35
chore: add github directory and associted files
417c1cc
chore: add nvmrc file
3d44469
chore: add scripts for linting and testing
72bee83
ci: create workflow
08c2020
ci: remove travis file
6e8890d
ci: move devDependencies to dependencies
dc06a33
ci: use npm ci
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
Empty file.
This file contains 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,66 @@ | ||
## Contributing | ||
The development of Scratch is an ongoing process, and we love to have people in the Scratch and open source communities help us along the way. | ||
|
||
### Ways to Help | ||
|
||
* **Documenting bugs** | ||
* If you've identified a bug in Scratch you should first check to see if it's been filed as an issue, if not you can file one. Make sure you follow the issue template. | ||
* It's important that we can consistently reproduce issues. When writing an issue, be sure to follow our [reproduction step guidelines](https://github.com/LLK/scratch-gui/wiki/Writing-good-repro-steps). | ||
* Some issues are marked "Needs Repro". Adding a comment with good reproduction steps to those issues is a great way to help. | ||
* If you don't have an issue in mind already, you can look through the [Bugs & Glitches forum.](https://scratch.mit.edu/discuss/3/) Look for users reporting problems, reproduce the problem yourself, and file new issues following our guidelines. | ||
|
||
* **Fixing bugs** | ||
* You can request to fix a bug in a comment on the issue if you at mention the repo coordinator, who for this repo is @chrisgarrity. | ||
* If the issue is marked "Help Wanted" you can go ahead and start working on it! | ||
* **We will only accept Pull Requests for bugs that have an issue filed that has a priority label** | ||
* If you're interested in fixing a bug with no issue, file the issue first and wait for it to have a priority added to it. | ||
|
||
* We are not looking for Pull Requests ("PR") for every issue and may deny a PR if it doesn't fit our criteria. | ||
* We are far more likely to accept a PR if it is for an issue marked with Help Wanted. | ||
* We will not accept PRs for issues marked with "Needs Discussion" or "Needs Design." | ||
* Wait until the Repo Coordinator assigns the issue to you before you begin work or submit a PR. | ||
|
||
### Learning Git and Github | ||
|
||
If you want to work on fixing issues, you should be familiar with Git and Github. | ||
|
||
* [Learn Git branching](https://learngitbranching.js.org/) includes an introduction to basic git commands and useful branching features. | ||
* Here's a general introduction to [contributing to an open source project](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github). | ||
|
||
**Important:** we follow the [Github Flow process](https://guides.github.com/introduction/flow/) as our development process. | ||
|
||
### How to Fix Bugs | ||
1. Identify which Github issue you are working on. Leave a comment on the issue to let us (and other contributors) know you're working on it. | ||
2. Make sure you have a fork of this repo (see [Github's forking a repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) for details) | ||
3. Switch to the `develop` branch, and pull down the latest changes from upstream | ||
4. Run the code, and reproduce the problem | ||
5. Create your branch from the `develop` branch | ||
6. Make code changes to fix the problem | ||
7. Run `npm test` to make sure that your changes pass our tests | ||
8. Commit your changes | ||
9. Push your branch to your fork | ||
10. Create your pull request | ||
1. Make sure to follow the template in the PR description | ||
1. Remember to check the “[Allow edits from maintainers](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork)” box | ||
|
||
When submitting pull requests keep in mind: | ||
* please be patient -- it can take a while to find time to review them | ||
* try to change the least amount of code necessary to fix the bug | ||
* the code can't be radically changed without significant coordination with the Scratch Team, so these types of changes should be avoided | ||
* if you find yourself changing a substantial amount of code or considering radical changes, please ask for clarification -- we may have envisioned a different approach, or underestimated the amount of effort | ||
|
||
### Suggestions | ||
![Block sketch](https://user-images.githubusercontent.com/3431616/77192550-1dcebe00-6ab3-11ea-9606-8ecd8500c958.png) | ||
|
||
Please note: **_we are unlikely to accept PRs with new features that haven't been thought through and discussed as a group_**. | ||
|
||
Why? Because we have a strong belief in the value of keeping things simple for new users. It's been said that the Scratch Team spends about one hour of design discussion for every pixel in Scratch. To learn more about our design philosophy, see [the Scratch Developers page](https://scratch.mit.edu/developers), or [this paper](http://web.media.mit.edu/~mres/papers/Scratch-CACM-final.pdf). | ||
|
||
We welcome suggestions! If you want to suggest a feature, please post in our [suggestions forum](https://scratch.mit.edu/discuss/1/). Your suggestion will be helped if you include a mockup design; this can be simple, even hand-drawn. | ||
|
||
### Other resources | ||
Beyond this repo, there are also some other resources that you might want to take a look at: | ||
* [Community Guidelines](https://github.com/LLK/scratch-www/wiki/Community-Guidelines) (we find it important to maintain a constructive and welcoming community, just like on Scratch) | ||
* [Open Source forum](https://scratch.mit.edu/discuss/49/) on Scratch | ||
* [Suggestions forum](https://scratch.mit.edu/discuss/1/) on Scratch | ||
* [Bugs & Glitches forum](https://scratch.mit.edu/discuss/3/) on Scratch |
This file contains 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,15 @@ | ||
### Expected Behavior | ||
|
||
_Please describe what should happen_ | ||
|
||
### Actual Behavior | ||
|
||
_Describe what actually happens_ | ||
|
||
### Steps to Reproduce | ||
|
||
_Explain what someone needs to do in order to see what's described in *Actual behavior* above_ | ||
|
||
### Operating System and Browser | ||
|
||
_e.g. Mac OS 10.11.6 Safari 10.0_ |
This file contains 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,39 @@ | ||
### Resolves | ||
|
||
_What Github issue does this resolve (please include link)?_ | ||
|
||
- Resolves # | ||
|
||
### Proposed Changes | ||
|
||
_Describe what this Pull Request does_ | ||
|
||
### Reason for Changes | ||
|
||
_Explain why these changes should be made_ | ||
|
||
### Test Coverage | ||
|
||
_Please show how you have added tests to cover your changes_ | ||
|
||
### Browser Coverage | ||
Check the OS/browser combinations tested (At least 2) | ||
|
||
Mac | ||
* [ ] Chrome | ||
* [ ] Firefox | ||
* [ ] Safari | ||
|
||
Windows | ||
* [ ] Chrome | ||
* [ ] Firefox | ||
* [ ] Edge | ||
|
||
Chromebook | ||
* [ ] Chrome | ||
|
||
iPad | ||
* [ ] Safari | ||
|
||
Android Tablet | ||
* [ ] Chrome |
This file contains 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,29 @@ | ||
name: Test Scratch Asset Types | ||
on: | ||
workflow_dispatch: | ||
push: | ||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
env: | ||
NODE_ENV: production | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: actions/setup-node@v3 | ||
with: | ||
cache: "npm" | ||
node-version-file: '.nvmrc' | ||
- name: Run NPM Commands | ||
run: | | ||
npm --production=false install | ||
npm --production=false update | ||
npm --production=false prune | ||
- name: Run Lint | ||
run: | | ||
npm run lint | ||
- name: Run Tests | ||
run: | | ||
npm run test | ||
|
||
|
||
|
This file contains 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 @@ | ||
v16 |
This file was deleted.
Oops, something went wrong.
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.
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.
Since this has a
package-lock.json
now, I think this should switch tonpm ci
: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.
good call!
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 moved everything to
dependencies
rather thandevDependencies
since there are only 5. Eslint was failing because it could not be found. IIRC npm ci does not include devDependncies with node_env=production.