Skip to content

Commit b7f76f6

Browse files
committed
Add .github files, CoC, templates, fix README links
1 parent 7fa9fa8 commit b7f76f6

File tree

6 files changed

+102
-25
lines changed

6 files changed

+102
-25
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Code of Conduct
2+
3+
Adapted from the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html).
4+
5+
## Conduct
6+
7+
* We are committed to providing a friendly, safe and welcoming environment for all, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, nationality, or other similar characteristic.
8+
* On any related online communication platform, please avoid using overtly sexual nicknames or other nicknames that might detract from a friendly, safe and welcoming environment for all.
9+
* Please be kind and courteous. There's no need to be mean or rude.
10+
* Respect that people have differences of opinion and that every design or implementation choice carries a trade-off and numerous costs. There is seldom a right answer.
11+
* Please keep unstructured critique to a minimum. If you have solid ideas you want to experiment with, make a fork and see how it works.
12+
* We will exclude you from interaction if you insult, demean or harass anyone. That is not welcome behaviour. We interpret the term "harassment" as including the definition in the <a href="http://citizencodeofconduct.org/">Citizen Code of Conduct</a>; if you have any lack of clarity about what might be included in that concept, please read their definition. In particular, we don't tolerate behavior that excludes people in socially marginalized groups.
13+
* Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or made uncomfortable by a community member, please contact one of the channel ops or any of the Daydream WebXR Moderation Team immediately. Whether you're a regular contributor or a newcomer, we care about making this community a safe place for you and we've got your back.
14+
* Likewise any spamming, trolling, flaming, baiting or other attention-stealing behaviour is not welcome.
15+
16+
## Moderation
17+
18+
19+
These are the policies for upholding our community's standards of conduct. If you feel that a thread needs moderation, please contact the Daydream WebXR members.
20+
21+
1. Remarks that violate the Daydream WebXR standards of conduct, including hateful, hurtful, oppressive, or exclusionary remarks, are not allowed. (Cursing is allowed, but never targeting another user, and never in a hateful manner.)
22+
2. Remarks that moderators find inappropriate, whether listed in the code of conduct or not, are also not allowed.
23+
3. Moderators will first respond to such remarks with a warning.
24+
4. If the warning is unheeded, the user will be "kicked," i.e., kicked out of the communication channel to cool off.
25+
5. If the user comes back and continues to make trouble, they will be banned, i.e., indefinitely excluded.
26+
6. Moderators may choose at their discretion to un-ban the user if it was a first offense and they offer the offended party a genuine apology.
27+
7. If a moderator bans someone and you think it was unjustified, please take it up with that moderator, or with a different moderator, **in private**. Complaints about bans in-channel are not allowed.
28+
8. Moderators are held to a higher standard than other community members. If a moderator creates an inappropriate situation, they should expect less leeway than others.
29+
30+
In the Daydream WebXR community we strive to go the extra step to look out for each other. Don't just aim to be technically unimpeachable, try to be your best self. In particular, avoid flirting with offensive or sensitive issues, particularly if they're off-topic; this all too often leads to unnecessary fights, hurt feelings, and damaged trust; worse, it can drive people away from the community entirely.
31+
32+
And if someone takes issue with something you said or did, resist the urge to be defensive. Just stop doing what it was they complained about and apologize. Even if you feel you were misinterpreted or unfairly accused, chances are good there was something you could've communicated better — remember that it's your responsibility to make your fellow contributors comfortable. Everyone wants to get along and we are all here first and foremost because we want to talk about cool technology. You will find that people will be eager to assume good intent and forgive as long as you earn their trust.
33+
34+
The enforcement policies listed above apply to all official Daydream WebXR venues; this GitHub repository currently; For other projects adopting this Code of Conduct, please contact the maintainers of those projects for enforcement. If you wish to use this code of conduct for your own project, consider explicitly mentioning your moderation policy or making a copy with your own moderation policy so as to avoid confusion.

.github/CONTRIBUTING.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
## Developing
2+
3+
If you're interested in developing and contributing on the polyfill itself, you'll need to
4+
have [npm] installed and familiarize yourself with some commands below. For full list
5+
of commands available, see `package.json` scripts.
6+
7+
```
8+
$ git clone git@github.com:googlevr/webvr-polyfill.git
9+
$ cd webvr-polyfill/
10+
11+
# Install dependencies
12+
$ npm install
13+
14+
# Build uncompressed JS file
15+
$ npm run build
16+
17+
# Run tests
18+
$ npm test
19+
20+
# Watch src/* directory and auto-rebuild on changes
21+
$ npm watch
22+
```
23+
24+
### Testing
25+
26+
Right now there are some unit tests in the configuration and logic for how things get polyfilled.
27+
Be sure to run tests before submitting any PRs, and bonus points for having new tests!
28+
29+
```
30+
$ npm test
31+
```
32+
33+
Due to the nature of the polyfill, be also sure to test the examples with your changes where appropriate.
34+
35+
### Releasing a new version
36+
37+
For maintainers only, to cut a new release for npm, use the [npm version] command. The `preversion`, `version` and `postversion` npm scripts will run tests, build, add built files and tag to git, push to github, and publish the new npm version.
38+
39+
`npm version <semverstring>`
40+
41+
## License
42+
43+
This program is free software for both commercial and non-commercial use,
44+
distributed under the [Apache 2.0 License](LICENSE).
45+
46+
[rollup]: https://rollupjs.org

.github/ISSUE_TEMPLATE.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
##### Description:
2+
3+
Please describe your issue or feature request in detail.
4+
Code and screenshots will help us diagnose the issue.
5+
6+
##### Additional Information:
7+
8+
* webvr-polyfill version:
9+
* Browser name/version/release channel:
10+
* Operating System:

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
##### Changes Proposed:
3+
4+
##### Fixes:
5+
6+
##### Checklist:
7+
8+
- [ ] Tested on the following platforms:
9+
- [ ] I've read CONTRIBUTING.md and signed the CLA (required)
10+
- [ ] This PR does not contain built changes in `dist/\*` (required)
11+
- [ ] This PR only contains one commit (required)

CONTRIBUTING.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Take a look at [basic WebVR samples][samples] that use this polyfill.
1313

1414
### Script
1515

16-
Download the build at [dist/webvr-polyfill.js] and include it as a script tag,
16+
Download the build at [dist/webvr-polyfill.js](dist/webvr-polyfill.js) and include it as a script tag,
1717
or use a CDN. You can also use the minified file in the same location as `webvr-polyfill.min.js`.
1818

1919
```html

0 commit comments

Comments
 (0)