Skip to content

Commit

Permalink
Temporary fixes for avatars in VR, to avoid issue #6. Also adds contr…
Browse files Browse the repository at this point in the history
…ibuting guidelines
  • Loading branch information
AlbertoElias committed Aug 3, 2018
1 parent 7129e23 commit 2660d4b
Show file tree
Hide file tree
Showing 14 changed files with 1,295 additions and 4,710 deletions.
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Contributing

We're an open project and really appreciate contributions of any kind

## Join the community

We're on Slack for any questions and discussions. Join using [this link](https://join.slack.com/t/wearesimbol/shared_invite/enQtNDA4NTMzODc0NzU1LTQzYTBkMjI4NmRhYjFhNTM2YWIxNjhiMmRlZTM1OTBiM2Y4ZWNlNWUwY2Q1ZGYwZTY2YTBkOTU0YzUyMWZhZTg)!

## File an issue

If there's something not working for you, please file an issue [here](https://github.com/wearesimbol/simbol/issues)

1. Search the issue track to check that your issue has not been filed before
2. Specify the Simbol version you are using
3. Specify browser version and OS
4. Describe the issue
5. If it applies to the issue, please provide code and/or screenshots. A Glitch based on [this example](https://glitch.com/edit/#!/a-simbol-example) would be great

## Raising Pull Requests

1. Have a [GitHub account](https://github.com/join) with [SSH keys][https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/] set up
2. [Fork](https://github.com/wearesimbol/simbol/fork) the repository on GitHub
3. Clone your fork of the repository locally (i.e., `git clone [email protected]:yourusername/simbol`)
4. Run `npm install` to get dependencies
5. Run `gulp js` when you make changes to compile it. The compiled version will be in `build/simbol.js`
6. If necessary, write [unit tests](https://github.com/wearesimbol/simbol/tree/master/test) and run with `gulp test`
7. Check it still passes the Simbol's linting rules by running `gulp lint`
6. Make changes to your fork of the repository, commit them, and push them (i.e., `git add -A . && git commit -m 'Fixes #25 by adding these changes' && git push origin mybranch`)
8. [Submit a pull request][https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github] to the master branch
9. If peers make any comments, address them
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,10 @@ Currently, [simbol](https://simbol.io) is dependent on several third party libra
* [WebVR Polyfill](https://github.com/googlevr/webvr-polyfill): Polyfill for mobile devices
* [uport-connect](https://github.com/uport-project/uport-connect): Underlying identity system that Virtual Personas is currently based on

## Contributing

Check out the [Contribution guide](https://github.com/wearesimbol/simbol/blob/master/CONTRIBUTING.md)! If you have any questions, we're also on [Slack](https://join.slack.com/t/wearesimbol/shared_invite/enQtNDA4NTMzODc0NzU1LTQzYTBkMjI4NmRhYjFhNTM2YWIxNjhiMmRlZTM1OTBiM2Y4ZWNlNWUwY2Q1ZGYwZTY2YTBkOTU0YzUyMWZhZTg)

## License

This program is free software and is distributed under an [MIT License](https://github.com/wearesimbol/simbol/blob/master/LICENSE).
1,928 changes: 386 additions & 1,542 deletions build/simbol.cjs.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion build/simbol.cjs.js.map

Large diffs are not rendered by default.

1,928 changes: 386 additions & 1,542 deletions build/simbol.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion build/simbol.js.map

Large diffs are not rendered by default.

1,928 changes: 386 additions & 1,542 deletions build/simbol.script.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion build/simbol.script.js.map

Large diffs are not rendered by default.

84 changes: 51 additions & 33 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"eventemitter3": "^3.1.0",
"load-bmfont": "^1.3.0",
"simple-peer": "^9.1.1",
"three": "^0.94.0",
"three": "^0.92.0",
"three-bmfont-text": "^2.2.1",
"uport-connect": "^0.7.3",
"webvr-polyfill": "^0.10.6"
Expand Down
Loading

0 comments on commit 2660d4b

Please sign in to comment.