Skip to content

Commit e9ea301

Browse files
authored
Merge pull request #263 from smalruby/merge/scratch-gui
Merge/scratch gui
2 parents ba6d3c0 + 2bd24c4 commit e9ea301

File tree

223 files changed

+3454
-2700
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

223 files changed

+3454
-2700
lines changed

.circleci/config.yml

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ aliases:
4040
- v1-npm-
4141
- &defaults
4242
docker:
43-
- image: circleci/node:8.16-browsers
43+
- image: circleci/node:10-browsers
4444
working_directory: ~/repo
4545

4646
jobs:
@@ -76,7 +76,7 @@ jobs:
7676
name: Unit
7777
environment:
7878
JEST_JUNIT_OUTPUT_DIR: test-results/unit
79-
command: npm run test:unit -- --reporters="default" --reporters="jest-junit" --coverage --coverageReporters=text --coverageReporters=lcov
79+
command: npm run test:unit -- --reporters="default" --reporters="jest-junit" --coverage --coverageReporters=text --coverageReporters=lcov --maxWorkers="2"
8080
- store_artifacts:
8181
path: coverage
8282
- store_test_results:
@@ -123,7 +123,7 @@ jobs:
123123
JEST_JUNIT_OUTPUT_DIR: test-results/integration
124124
command: |
125125
export TESTFILES=$(circleci tests glob "test/integration/*.test.js" | circleci tests split --split-by=timings)
126-
$(npm bin)/jest ${TESTFILES} --reporters="default" --reporters="jest-junit"
126+
$(npm bin)/jest ${TESTFILES} --reporters="default" --reporters="jest-junit" --runInBand
127127
- store_test_results:
128128
path: test-results
129129

@@ -162,7 +162,7 @@ jobs:
162162
git config --global user.email $(git log --pretty=format:"%ae" -n1)
163163
git config --global user.name $(git log --pretty=format:"%an" -n1)
164164
- run: npm run deploy -- -e $CIRCLE_BRANCH
165-
165+
166166
workflows:
167167
version: 2
168168
build-test-deploy:
@@ -186,22 +186,25 @@ workflows:
186186
- store_dist:
187187
requires:
188188
- build
189-
# Disable deployment while running in parallel with Travis
190-
# - deploy-npm:
189+
- deploy-npm:
190+
requires:
191+
- lint
192+
- unit
193+
- integration
194+
- build
195+
filters:
196+
branches:
197+
only:
198+
- master
199+
- develop
200+
- /^hotfix\/.*/
201+
# - deploy-gh-pages:
191202
# requires:
192203
# - lint
193204
# - unit
194205
# - integration
195206
# - build
196207
# filters:
197208
# branches:
198-
# only:
199-
# - master
200-
# - develop
201-
# - /^hotfix\/.*/
202-
# - deploy-gh-pages:
203-
# requires:
204-
# - lint
205-
# - unit
206-
# - integration
207-
# - build
209+
# ignore:
210+
# - ^dependabot/.*/

.github/CONTRIBUTING.md

Lines changed: 56 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,64 @@
11
## Contributing
22
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.
33

4-
If you're interested in contributing, please take a look at the [issues](https://github.com/LLK/scratch-gui/issues) on this repository.
5-
Two great ways of helping are by identifying bugs and documenting them as issues, or fixing issues and creating pull requests. When looking for bugs to fix, please look for the ["Help Wanted" label](https://github.com/LLK/scratch-gui/issues?q=label%3A%22help+wanted%22). Bugs with this label have been specifically set aside for Open Source contributors. Issues without the label can also be worked on but we ask that you comment on the issue prior to starting work. When submitting pull requests please be patient -- it can take a while to find time to review them. The organization and class structures can't be radically changed without significant coordination and collaboration from the Scratch Team, so these types of changes should be avoided.
4+
### Ways to Help
65

7-
It's been said that the Scratch Team spends about one hour of design discussion for every pixel in Scratch, but some think that estimate is a little low. While we welcome suggestions for new features in our [suggestions forum](https://scratch.mit.edu/discuss/1/) (especially ones that come with mockups), 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. 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).
6+
* **Documenting bugs**
7+
* 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.
8+
* 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).
9+
* Some issues are marked "Needs Repro". Adding a comment with good reproduction steps to those issues is a great way to help.
10+
* 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.
811

12+
* **Fixing bugs**
13+
* 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.
14+
* If the issue is marked "Help Wanted" you can go ahead and start working on it!
15+
* **We will only accept Pull Requests for bugs that have an issue filed that has a priority label**
16+
* 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.
17+
18+
* We are not looking for Pull Requests ("PR") for every issue and may deny a PR if it doesn't fit our criteria.
19+
* We are far more likely to accept a PR if it is for an issue marked with Help Wanted.
20+
* We will not accept PRs for issues marked with "Needs Discussion" or "Needs Design."
21+
* Wait until the Repo Coordinator assigns the issue to you before you begin work or submit a PR.
22+
23+
### Learning Git and Github
24+
25+
If you want to work on fixing issues, you should be familiar with Git and Github.
26+
27+
* [Learn Git branching](https://learngitbranching.js.org/) includes an introduction to basic git commands and useful branching features.
28+
* 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).
29+
30+
**Important:** we follow the [Github Flow process](https://guides.github.com/introduction/flow/) as our development process.
31+
32+
### How to Fix Bugs
33+
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.
34+
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)
35+
3. Switch to the `develop` branch, and pull down the latest changes from upstream
36+
4. Run the code, and reproduce the problem
37+
5. Create your branch from the `develop` branch
38+
6. Make code changes to fix the problem
39+
7. Run `npm test` to make sure that your changes pass our tests
40+
8. Commit your changes
41+
9. Push your branch to your fork
42+
10. Create your pull request
43+
1. Make sure to follow the template in the PR description
44+
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
45+
46+
When submitting pull requests keep in mind:
47+
* please be patient -- it can take a while to find time to review them
48+
* try to change the least amount of code necessary to fix the bug
49+
* the code can't be radically changed without significant coordination with the Scratch Team, so these types of changes should be avoided
50+
* 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
51+
52+
### Suggestions
53+
![Block sketch](https://user-images.githubusercontent.com/3431616/77192550-1dcebe00-6ab3-11ea-9606-8ecd8500c958.png)
54+
55+
Please note: **_we are unlikely to accept PRs with new features that haven't been thought through and discussed as a group_**.
56+
57+
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).
58+
59+
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.
60+
61+
### Other resources
962
Beyond this repo, there are also some other resources that you might want to take a look at:
1063
* [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)
1164
* [Open Source forum](https://scratch.mit.edu/discuss/49/) on Scratch

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,13 @@ npm install --no-optional --save-dev react-responsive@^5.0.0
155155

156156
Further reading: [Stack Overflow](https://stackoverflow.com/questions/46602286/npm-requires-a-peer-of-but-all-peers-are-in-package-json-and-node-modules)
157157

158+
## Troubleshooting
159+
160+
If you run into npm install errors, try these steps:
161+
1. run `npm cache clean --force`
162+
2. Delete the node_modules directory
163+
3. Delete package-lock.json
164+
4. run `npm install` again
158165

159166
## Publishing to GitHub Pages
160167

0 commit comments

Comments
 (0)