From b7f76f6b85a4bae1c3f347aee0890d462d4a0821 Mon Sep 17 00:00:00 2001 From: Jordan Santell Date: Mon, 18 Dec 2017 14:55:20 -0800 Subject: [PATCH] Add .github files, CoC, templates, fix README links --- .github/CODE_OF_CONDUCT.md | 34 +++++++++++++++++++++++ .github/CONTRIBUTING.md | 46 ++++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE.md | 10 +++++++ .github/PULL_REQUEST_TEMPLATE.md | 11 ++++++++ CONTRIBUTING.md | 24 ----------------- README.md | 2 +- 6 files changed, 102 insertions(+), 25 deletions(-) create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 CONTRIBUTING.md diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..9ea4888 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,34 @@ +# Code of Conduct + +Adapted from the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html). + +## Conduct + +* 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. +* 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. +* Please be kind and courteous. There's no need to be mean or rude. +* 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. +* 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. +* 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 Citizen Code of Conduct; 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. +* 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. +* Likewise any spamming, trolling, flaming, baiting or other attention-stealing behaviour is not welcome. + +## Moderation + + +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. + +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.) +2. Remarks that moderators find inappropriate, whether listed in the code of conduct or not, are also not allowed. +3. Moderators will first respond to such remarks with a warning. +4. If the warning is unheeded, the user will be "kicked," i.e., kicked out of the communication channel to cool off. +5. If the user comes back and continues to make trouble, they will be banned, i.e., indefinitely excluded. +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. +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. +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. + +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. + +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. + +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. diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..cf88400 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,46 @@ +## Developing + +If you're interested in developing and contributing on the polyfill itself, you'll need to +have [npm] installed and familiarize yourself with some commands below. For full list +of commands available, see `package.json` scripts. + +``` +$ git clone git@github.com:googlevr/webvr-polyfill.git +$ cd webvr-polyfill/ + +# Install dependencies +$ npm install + +# Build uncompressed JS file +$ npm run build + +# Run tests +$ npm test + +# Watch src/* directory and auto-rebuild on changes +$ npm watch +``` + +### Testing + +Right now there are some unit tests in the configuration and logic for how things get polyfilled. +Be sure to run tests before submitting any PRs, and bonus points for having new tests! + +``` +$ npm test +``` + +Due to the nature of the polyfill, be also sure to test the examples with your changes where appropriate. + +### Releasing a new version + +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. + +`npm version ` + +## License + +This program is free software for both commercial and non-commercial use, +distributed under the [Apache 2.0 License](LICENSE). + +[rollup]: https://rollupjs.org diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..b23a773 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,10 @@ +##### Description: + +Please describe your issue or feature request in detail. +Code and screenshots will help us diagnose the issue. + +##### Additional Information: + +* webvr-polyfill version: +* Browser name/version/release channel: +* Operating System: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..2445583 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,11 @@ + +##### Changes Proposed: + +##### Fixes: + +##### Checklist: + +- [ ] Tested on the following platforms: +- [ ] I've read CONTRIBUTING.md and signed the CLA (required) +- [ ] This PR does not contain built changes in `dist/\*` (required) +- [ ] This PR only contains one commit (required) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 7eafb84..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,24 +0,0 @@ -# Building - -This project uses [webpack] to manage dependencies and build the library. `npm run watch` is -especially convenient to preserve the write-and-reload model of development. -This package lives in the npm index. - -Relevant commands: - -* `npm install`: installs the dependencies. -* `npm start`: auto-builds the module whenever any source changes and serves the example -content on `http://0.0.0.0:8080/`. -* `npm run build`: builds the module. -* `npm run watch`: alias for `npm start`. - -# Updating the npm entry - -Once changes are made, a new version can be built, committed in git with tags, -and published to npm via: - -`$ node scripts/publish.js RELEASE` - -Where `RELEASE` defaults to `patch`, but other [release types from semver](https://www.npmjs.com/package/semver#functions) can be used, like `major` and `minor`. - -[webpack]: https://webpack.js.org diff --git a/README.md b/README.md index 0925417..3477a3f 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Take a look at [basic WebVR samples][samples] that use this polyfill. ### Script -Download the build at [dist/webvr-polyfill.js] and include it as a script tag, +Download the build at [dist/webvr-polyfill.js](dist/webvr-polyfill.js) and include it as a script tag, or use a CDN. You can also use the minified file in the same location as `webvr-polyfill.min.js`. ```html