Do's:

    1. Checkout a new branch from the relevant branch for development

    2. Run npm test and make sure all tests pass before submitting a PR

Don'ts:

    1. DO NOT submit PR against master branch

    2. DO NOT check into build folder in commits

If you are going to:

• Put <title> (#<issue-id>) in your PR title for a better release log, e.g. update entities encoding/decoding (#3899)
• Provide detailed description in the PR
• Add relevant tests
• Run tests. Make sure newly added code does not break existing functionality

git checkout -b i-found-a-bug
# ... fix the bug ..
# only continue to next step if all tests pass
npm test
git add <relevant-files-that-have-been-modified>
git commit -m 'update entities encoding/decoding'
git push origin i-found-a-bug

• Don't forget to submit a pull request :P

• Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it "new-features" before working on it
• Create a new branch
• Add relevant tests
• Submit PR

Static resource and production dependencies (stat.min.js & three.min.js)

Contains files for distribution. This folder will only be updated if there is a new release.
Latest development is reflected in branches

Carefully selected examples to illustrate major functionality of the APIs

Source code

Unit tests for each module of the source file.

Node.js (v9.10.0) is required

1. Fork the repo

2. Clone your own Github repo to your local machine

git clone https://github.com/<your-github-id>/Gio.js.git

3. Install dev tools/libs

npm install

yarn install