This repository has been archived by the owner on Aug 12, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 320
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #324 from LLK/release/2020-09-14
[MASTER] Release/2020 09 14
- Loading branch information
Showing
71 changed files
with
11,437 additions
and
1,001 deletions.
There are no files selected for viewing
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,60 @@ | ||
## Contributing | ||
The development of ScratchJr is an ongoing process, and we love to have people in the ScratchJr and open source communities help us along the way. | ||
|
||
### Ways to Help | ||
|
||
* **Documenting bugs** | ||
* If you've identified a bug in ScratchJr 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). The example is based on Scratch, but the same principles apply to ScratchJr. | ||
* Some issues are marked "Needs Repro". Adding a comment with good reproduction steps to those issues is a great way to help. | ||
|
||
* **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." | ||
|
||
### 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 or ScratchJr. To learn more about our design philosophy, see [the Scratch Developers page](https://scratch.mit.edu/developers), or [this paper](https://ase.tufts.edu/DevTech/publications/scratchjr_idc_2013.pdf). | ||
|
||
### 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 for ScratchJr, just like on Scratch) | ||
* [Open Source forum](https://scratch.mit.edu/discuss/49/) 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, screenshots are helpful._ | ||
|
||
### Steps to Reproduce | ||
|
||
_Explain what someone needs to do in order to see what's described in *Actual behavior* above_ | ||
|
||
### Device and Operating System | ||
|
||
_e.g. iPad mini, iOS 10.3 or Samsung Galaxy Tab S6, Android 10_ |
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,18 @@ | ||
### Resolves | ||
|
||
_What Github issue does this resolve (please include link)? Please make sure that the PR title reflects what the PR will do, not what is changing. | ||
Please do not submit PRs that are not associated with a Github issue, or that only partially implement an issue._ | ||
|
||
- 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, or provide the testing steps to verify the change. Screenshots that show the change are also helpful._ |
This file was deleted.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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
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
Oops, something went wrong.