-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Temporary fixes for avatars in VR, to avoid issue #6. Also adds contr…
…ibuting guidelines
- Loading branch information
1 parent
7129e23
commit 2660d4b
Showing
14 changed files
with
1,295 additions
and
4,710 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,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 |
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
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
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
Oops, something went wrong.