Skip to content

Commit

Permalink
Fix link to tutorial and chore cleanups (GoogleCloudPlatform#180)
Browse files Browse the repository at this point in the history
* Update link to bookshelf tutorial

* Fix formatting in README

* Update repo tools

* Add CONTRIBUTORS file

* Add CoC

* Add mailmap for future repo tools runs
  • Loading branch information
fhinkel authored Oct 4, 2018
1 parent 96c3e59 commit 9367f2e
Show file tree
Hide file tree
Showing 7 changed files with 137 additions and 53 deletions.
27 changes: 12 additions & 15 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
.DS_Store
node_modules
**/node_modules/**
*.log
coverage/
test/encrypted/nodejs-docs-samples.json
*.iml
.idea/
key.json
**/*.log
**/node_modules
.coverage
.nyc_output
secrets-*
repo-tools-cloudbuild.yaml
package-lock.json
**/package-lock.json
yarn.lock
**/yarn.lock
docs/
out/
build/
system-test/secrets.js
system-test/*key.json
*.lock
.DS_Store
google-cloud-logging-winston-*.tgz
google-cloud-logging-bunyan-*.tgz
29 changes: 29 additions & 0 deletions .mailmap
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
JJ Geewax <jjg@google.com> JJ Geewax <jj@geewax.org>
Jason Dobry <jdobry@google.com> Jason Dobry <jason.dobry@gmail.com>
Jason Dobry <jdobry@google.com> Jason Dobry <jmdobry@users.noreply.github.com>
Jun Mukai <mukai@google.com> Jun Mukai <jun.mukai@gmail.com>
Luke Sneeringer <lukesneeringer@google.com> Luke Sneeringer <luke@sneeringer.com>
Stephen Sawchuk <sawchuk@gmail.com> Stephen <stephenplusplus@users.noreply.github.com>
Stephen Sawchuk <sawchuk@gmail.com> Stephen Sawchuk <stephenplusplus@users.noreply.github.com>
Vikas Kedia <vikask@google.com> Vikas Kedia <vikas.kedia@gmail.com>
Alexander Fenster <fenster@google.com> Alexander Fenster <github@fenster.name>
Ali Ijaz Sheikh <ofrobots@google.com>
Austin Peterson <austin@akpwebdesign.com>
Dave Gramlich <callmehiphop@gmail.com>
Eric Uldall <ericuldall@gmail.com>
Ernest Landrito <landrito@google.com>
Justin King <jcking@mtu.edu>
Jason Dobry <jdobry@google.com> Jason Dobry <jmdobry@users.noreply.github.com>
Jason Dobry <jdobry@google.com> Jason Dobry <jason.dobry@gmail.com>
Karolis Narkevicius <karolis.n@gmail.com>
Kelvin Jin <kelvinjin@google.com>
Luke Sneeringer <lukesneeringer@google.com> Luke Sneeringer <luke@sneeringer.com>
Matthew Loring <matthewloring@users.noreply.github.com>
Michael Prentice <splaktar@gmail.com>
Stephen Sawchuk <sawchuk@gmail.com> Stephen Sawchuk <stephenplusplus@users.noreply.github.com>
Stephen Sawchuk <sawchuk@gmail.com> Stephen Sawchuk <stephenplusplusplus@gmail.com>
Stephen Sawchuk <sawchuk@gmail.com> Stephen <stephenplusplus@users.noreply.github.com>
Tim Swast <swast@google.com>
F. Hinkelmann <fhinkel@vt.edu> Franziska Hinkelmann <franzih@chromium.org>
Jon Wayne Parrott <jonwayne@google.com> Jon Wayne Parrott <jon.wayne.parrott@gmail.com>
Jon Wayne Parrott <jonwayne@google.com> Jonathan Wayne Parrott <jon.wayne.parrott@gmail.com>
43 changes: 43 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Contributor Code of Conduct

As contributors and maintainers of this project,
and in the interest of fostering an open and welcoming community,
we pledge to respect all people who contribute through reporting issues,
posting feature requests, updating documentation,
submitting pull requests or patches, and other activities.

We are committed to making participation in this project
a harassment-free experience for everyone,
regardless of level of experience, gender, gender identity and expression,
sexual orientation, disability, personal appearance,
body size, race, ethnicity, age, religion, or nationality.

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery
* Personal attacks
* Trolling or insulting/derogatory comments
* Public or private harassment
* Publishing other's private information,
such as physical or electronic
addresses, without explicit permission
* Other unethical or unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct.
By adopting this Code of Conduct,
project maintainers commit themselves to fairly and consistently
applying these principles to every aspect of managing this project.
Project maintainers who do not follow or enforce the Code of Conduct
may be permanently removed from the project team.

This code of conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community.

Instances of abusive, harassing, or otherwise unacceptable behavior
may be reported by opening an issue
or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0,
available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)
16 changes: 16 additions & 0 deletions CONTRIBUTORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# The names of individuals who have contributed to this project.
#
# Names are formatted as:
# name <email>
#
Ace Nassri <anassri@google.com>
Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
Allen Day <allenday@users.noreply.github.com>
André Cipriani Bandarra <andreban@gmail.com>
Dominik Staskiewicz <stadominik@gmail.com>
F. Hinkelmann <fhinkel@vt.edu>
Jason Dobry <jdobry@google.com>
Jon Wayne Parrott <jonwayne@google.com>
Michael McDonald <mcdonald@firebase.com>
Steve Perry <steveperry-53@users.noreply.github.com>
chenyumic <chenyumic@google.com>
1 change: 1 addition & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
Expand Down
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,12 @@ Tutorial | Folder | Build Status
has enabled all the APIs used by these tutorials.
* Make sure you've got the required environment variables set. (Take a look at
the various config.js files.)
* `git clone git@github.com:GoogleCloudPlatform/nodejs-getting-started.git`
* `cd nodejs-getting-started`
* `npm install`
* `npm test`
```bash
git clone git@github.com:GoogleCloudPlatform/nodejs-getting-started.git
cd nodejs-getting-started
npm install
npm test
```

## Licensing

Expand All @@ -42,7 +44,7 @@ the various config.js files.)
[travis-link]: https://travis-ci.org/GoogleCloudPlatform/nodejs-getting-started
[coveralls-badge]: https://codecov.io/github/GoogleCloudPlatform/nodejs-getting-started/coverage.svg?branch=master
[coveralls-link]: https://codecov.io/github/GoogleCloudPlatform/nodejs-getting-started?branch=master
[getting-started]: http://cloud.google.com/nodejs/getting-started
[getting-started]: https://cloud.google.com/nodejs/getting-started/tutorial-app
[step-1]: https://cloud.google.com/nodejs/getting-started/hello-world
[step-1-code]: https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/1-hello-world
[step-2]: https://cloud.google.com/nodejs/getting-started/using-structured-data
Expand Down
62 changes: 29 additions & 33 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,38 +1,15 @@
{
"name": "nodejs-getting-started",
"version": "1.0.0",
"description": "End to end sample for running Node.js applications on Google Cloud Platform",
"version": "1.0.0",
"license": "Apache-2.0",
"author": "Google Inc.",
"engines": {
"node": ">=4.3.2"
},
"repository": "https://github.com/GoogleCloudPlatform/nodejs-getting-started",
"main": "src/index.js",
"private": true,
"scripts": {
"lint": "semistandard \"**/*.js\"",
"ava": "ava -s -t 30s --tap \"**/!(datastore).test.js\"",
"test": "npm run lint && npm run ava",
"cover": "nyc --cache npm test; nyc report --reporter=html",
"e2e": "mocha test/e2e.js -t 1800000",
"unify": "node scripts/unify",
"update-dependencies": "./scripts/update-dependencies.sh"
},
"author": "Google Inc.",
"contributors": [
{
"name": "Jon Wayne Parrott",
"email": "jonwayne@google.com"
},
{
"name": "Jonathan Simon",
"email": "jbsimon@google.com"
},
{
"name": "Jason Dobry",
"email": "jdobry@google.com"
},
{
"name": "Ace Nassri",
"email": "anassri@google.com"
}
],
"license": "Apache-2.0",
"semistandard": {
"globals": [
"after",
Expand All @@ -43,8 +20,27 @@
"it"
]
},
"engines": {
"node": ">=4.3.2"
"contributors": [
"Ace Nassri <anassri@google.com>",
"Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>",
"Allen Day <allenday@users.noreply.github.com>",
"André Cipriani Bandarra <andreban@gmail.com>",
"Dominik Staskiewicz <stadominik@gmail.com>",
"F. Hinkelmann <fhinkel@vt.edu>",
"Jason Dobry <jdobry@google.com>",
"Jon Wayne Parrott <jonwayne@google.com>",
"Michael McDonald <mcdonald@firebase.com>",
"Steve Perry <steveperry-53@users.noreply.github.com>",
"chenyumic <chenyumic@google.com>"
],
"scripts": {
"lint": "semistandard \"**/*.js\"",
"ava": "ava -s -t 30s --tap \"**/!(datastore).test.js\"",
"test": "npm run lint && npm run ava",
"cover": "nyc --cache npm test; nyc report --reporter=html",
"e2e": "mocha test/e2e.js -t 1800000",
"unify": "node scripts/unify",
"update-dependencies": "./scripts/update-dependencies.sh"
},
"dependencies": {
"@google-cloud/datastore": "^1.3.4",
Expand Down Expand Up @@ -74,7 +70,7 @@
"winston": "^2.4.0"
},
"devDependencies": {
"@google-cloud/nodejs-repo-tools": "^2.2.1",
"@google-cloud/nodejs-repo-tools": "^2.3.5",
"ava": "^0.25.0",
"npm-check-updates": "^2.13.0",
"proxyquire": "^1.8.0",
Expand Down

0 comments on commit 9367f2e

Please sign in to comment.