mirror of
https://github.com/google/blockly.git
synced 2025-12-16 06:10:12 +01:00
Merge branch 'master' into rc_2021_3
This commit is contained in:
Maribeth Bottorff
GitHub
10
.github/PULL_REQUEST_TEMPLATE.md
vendored
10
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -20,6 +20,14 @@
|
||||
|
||||
<!-- TODO: Describe what this Pull Request does. Include screenshots if applicable. -->
|
||||
|
||||
#### Behavior Before Change
|
||||
|
||||
<!--TODO: Image, gif or explanation of behavior before this pull request. -->
|
||||
|
||||
#### Behavior After Change
|
||||
|
||||
<!--TODO: Image, gif or explanation of behavior after this pull request. -->
|
||||
|
||||
### Reason for Changes
|
||||
|
||||
<!--TODO: Explain why these changes should be made. Include screenshots if applicable. -->
|
||||
@@ -31,7 +39,7 @@
|
||||
- uncomment the systems in the list below.
|
||||
-->
|
||||
|
||||
Tested on:
|
||||
<!-- Tested on: -->
|
||||
<!-- * Desktop Chrome -->
|
||||
<!-- * Desktop Firefox -->
|
||||
<!-- * Desktop Safari -->
|
||||
|
||||
68
README.md
68
README.md
@@ -1,41 +1,58 @@
|
||||
# Blockly [](https://travis-ci.org/google/blockly)
|
||||
|
||||
|
||||
Google's Blockly is a web-based, visual programming editor. Users can drag
|
||||
blocks together to build programs. All code is free and open source.
|
||||
|
||||
**The project page is https://developers.google.com/blockly/**
|
||||
Google's Blockly is a library that adds a visual code editor to web and mobile apps. The Blockly editor uses interlocking, graphical blocks to represent code concepts like variables, logical expressions, loops, and more. It allows users to apply programming principles without having to worry about syntax or the intimidation of a blinking cursor on the command line. All code is free and open source.
|
||||
|
||||
|
||||
|
||||
Blockly has an active [developer forum](https://groups.google.com/forum/#!forum/blockly). Please drop by and say hello. Show us your prototypes early; collectively we have a lot of experience and can offer hints which will save you time. We actively monitor the forums and typically respond to questions within 2 working days.
|
||||
## Getting Started with Blockly
|
||||
|
||||
Blockly has many resources for learning how to use the library. Start at our [Google Developers Site](https://developers.google.com/blockly) to read the documentation on how to get started, configure Blockly, and integrate it into your application. The developers site also contains links to:
|
||||
|
||||
* [Getting Started article](https://developers.google.com/blockly/guides/get-started/web)
|
||||
* [Getting Started codelab](https://blocklycodelabs.dev/codelabs/getting-started/index.html#0)
|
||||
* [More codelabs](https://blocklycodelabs.dev/)
|
||||
* [Demos and plugins](https://google.github.io/blockly-samples/)
|
||||
|
||||
Help us focus our development efforts by telling us [what you are doing with
|
||||
Blockly](https://developers.google.com/blockly/registration). The questionnaire only takes
|
||||
a few minutes and will help us better support the Blockly community.
|
||||
|
||||
Cross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs](https://saucelabs.com)
|
||||
### Installing Blockly
|
||||
|
||||
We support IE11 and test it using [BrowserStack](https://browserstack.com)
|
||||
Blockly is [available on npm](https://www.npmjs.com/package/blockly).
|
||||
|
||||
Want to contribute? Great! First, read [our guidelines for contributors](https://developers.google.com/blockly/guides/modify/contributing).
|
||||
|
||||
## Releases
|
||||
|
||||
The next major release will be **December 17th, 2020**.
|
||||
|
||||
We release by pushing the latest code to the master branch, followed by updating our [docs](https://developers.google.com/blockly) and [demo pages](https://blockly-demo.appspot.com). We typically release a new version of Blockly once a quarter (every 3 months). If there are breaking bugs, such as a crash when performing a standard action or a rendering issue that makes Blockly unusable, we will cherry-pick fixes to master between releases to fix them. The [releases page](https://github.com/google/blockly/releases) has a list of all releases.
|
||||
|
||||
Releases are tagged by the release date (YYYYMMDD) with a leading '2.' and a trailing '.0' in case we ever need a major or minor version (such as [2.20190722.1](https://github.com/google/blockly/tree/2.20190722.1)). If you're using npm, you can install the ``blockly`` package on npm:
|
||||
```bash
|
||||
npm install blockly
|
||||
```
|
||||
|
||||
### New APIs
|
||||
For more information on installing and using Blockly, see the [Getting Started article](https://developers.google.com/blockly/guides/get-started/web).
|
||||
|
||||
Once a new API is merged into master it is considered beta until the following release. We generally try to avoid changing an API after it has been merged to master, but sometimes we need to make changes after seeing how an API is used. If an API has been around for at least two releases we'll do our best to avoid breaking it.
|
||||
### Getting Help
|
||||
* [Report a bug](https://developers.google.com/blockly/guides/modify/contribute/write_a_good_issue) or file a feature request on GitHub
|
||||
* Ask a question, or search others' questions, on our [developer forum](https://groups.google.com/forum/#!forum/blockly). You can also drop by to say hello and show us your prototypes; collectively we have a lot of experience and can offer hints which will save you time. We actively monitor the forums and typically respond to questions within 2 working days.
|
||||
|
||||
Unreleased APIs may change radically. Anything that is in `develop` but not `master` is subject to change without warning.
|
||||
### blockly-samples
|
||||
|
||||
We have a number of resources such as example code, demos, and plugins in another repository called [blockly-samples](https://github.com/google/blockly-samples/). A plugin is a self-contained piece of code that adds functionality to Blockly. Plugins can add fields, define themes, create renderers, and much more. For more information, see the [Plugins documentation](https://developers.google.com/blockly/guides/plugins/overview).
|
||||
|
||||
## Contributing to Blockly
|
||||
|
||||
Want to make Blockly better? We welcome contributions to Blockly in the form of pull requests, bug reports, documentation, answers on the forum, and more! Check out our [Contributing Guidelines](https://developers.google.com/blockly/guides/modify/contributing) for more information. You might also want to look for issues tagged "[Help Wanted](https://github.com/google/blockly/labels/help%20wanted)" which are issues we think would be great for external contributors to help with.
|
||||
|
||||
## Releases
|
||||
|
||||
The next major release will be **March 25th, 2021**.
|
||||
|
||||
We release by pushing the latest code to the master branch, followed by updating the npm package, our [docs](https://developers.google.com/blockly), and [demo pages](https://google.github.io/blockly-samples/). We typically release a new version of Blockly once a quarter (every 3 months). If there are breaking bugs, such as a crash when performing a standard action or a rendering issue that makes Blockly unusable, we will cherry-pick fixes to master between releases to fix them. The [releases page](https://github.com/google/blockly/releases) has a list of all releases.
|
||||
|
||||
Releases are tagged by the release date (YYYYMMDD) with a leading '4.' and a trailing '.0' in case we ever need a major or patch version (such as [2.20190722.1](https://github.com/google/blockly/tree/2.20190722.1)). Releases that have breaking changes or are otherwise not backwards compatible will have a new major version. Patch versions are reserved for bug-fix patches between scheduled releases.
|
||||
|
||||
We now have a [beta release on npm](https://www.npmjs.com/package/blockly?activeTab=versions). If you'd like to test the upcoming release, or try out a not-yet-released new API, you can use the beta channel with:
|
||||
|
||||
```bash
|
||||
npm install blockly@beta
|
||||
```
|
||||
As it is a beta channel, it may be less stable, and the APIs there are subject to change.
|
||||
|
||||
### Branches
|
||||
|
||||
@@ -47,6 +64,12 @@ There are two main branches for Blockly.
|
||||
|
||||
**other branches:** - Larger changes may have their own branches until they are good enough for people to try out. These will be developed separately until we think they are almost ready for release. These branches typically get merged into develop immediately after a release to allow extra time for testing.
|
||||
|
||||
### New APIs
|
||||
|
||||
Once a new API is merged into master it is considered beta until the following release. We generally try to avoid changing an API after it has been merged to master, but sometimes we need to make changes after seeing how an API is used. If an API has been around for at least two releases we'll do our best to avoid breaking it.
|
||||
|
||||
Unreleased APIs may change radically. Anything that is in `develop` but not `master` is subject to change without warning.
|
||||
|
||||
## Issues and Milestones
|
||||
|
||||
We typically triage all bugs within 2 working days, which includes adding any appropriate labels and assigning it to a milestone. Please keep in mind, we are a small team so even feature requests that everyone agrees on may not be prioritized.
|
||||
@@ -58,3 +81,8 @@ We typically triage all bugs within 2 working days, which includes adding any ap
|
||||
**Bug Bash Backlog** - These are bugs that we're still prioritizing. They haven't been added to a specific release yet, but we'll consider them for each release depending on relative priority and available time.
|
||||
|
||||
**Icebox** - These are bugs that we do not intend to spend time on. They are either too much work or minor enough that we don't expect them to ever take priority. We are still happy to accept pull requests for these bugs.
|
||||
|
||||
## Good to Know
|
||||
|
||||
* Cross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs](https://saucelabs.com)
|
||||
* We support IE11 and test it using [BrowserStack](https://browserstack.com)
|
||||
|
||||
@@ -49,13 +49,13 @@ if (loc.match('/apps/plane/plane.html')) {
|
||||
|
||||
if (loc.match('/apps/puzzle/')) {
|
||||
// Puzzle moved to Blockly Games on 15 Oct 2014.
|
||||
loc = 'https://blockly-games.appspot.com/puzzle';
|
||||
loc = 'https://blockly.games/puzzle';
|
||||
} else if (loc.match('/apps/maze/')) {
|
||||
// Maze moved to Blockly Games on 10 Nov 2014.
|
||||
loc = 'https://blockly-games.appspot.com/maze';
|
||||
loc = 'https://blockly.games/maze';
|
||||
} else if (loc.match('/apps/turtle/')) {
|
||||
// Turtle moved to Blockly Games on 10 Nov 2014.
|
||||
loc = 'https://blockly-games.appspot.com/turtle';
|
||||
loc = 'https://blockly.games/turtle';
|
||||
} else if (loc.match('/apps/')) {
|
||||
// Remaining apps moved to demos on 20 Nov 2014.
|
||||
loc = loc.replace('/apps/', '/demos/');
|
||||
|
||||
12
package-lock.json
generated
12
package-lock.json
generated
@@ -3526,12 +3526,6 @@
|
||||
"dev": true,
|
||||
"optional": true
|
||||
},
|
||||
"ini": {
|
||||
"version": "1.3.5",
|
||||
"bundled": true,
|
||||
"dev": true,
|
||||
"optional": true
|
||||
},
|
||||
"is-fullwidth-code-point": {
|
||||
"version": "1.0.0",
|
||||
"bundled": true,
|
||||
@@ -4746,9 +4740,9 @@
|
||||
"dev": true
|
||||
},
|
||||
"ini": {
|
||||
"version": "1.3.5",
|
||||
"resolved": "https://registry.npmjs.org/ini/-/ini-1.3.5.tgz",
|
||||
"integrity": "sha512-RZY5huIKCMRWDUqZlEi72f/lmXKMvuszcMBduliQ3nnWbx9X/ZBQO7DijMEYS9EhHBb2qacRUMtC7svLwe0lcw==",
|
||||
"version": "1.3.8",
|
||||
"resolved": "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz",
|
||||
"integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==",
|
||||
"dev": true
|
||||
},
|
||||
"interpret": {
|
||||
|
||||
Reference in New Issue
Block a user