From 9a569224516c13dc814e1e83cb18362c0248ea5c Mon Sep 17 00:00:00 2001 From: Mayur Kale Date: Mon, 24 Jun 2019 09:26:29 -0700 Subject: [PATCH] Rename Node to js (#54) --- CONTRIBUTING.md | 6 +++--- README.md | 15 +++++++++++---- package.json | 2 +- packages/opentelemetry-core/package.json | 2 +- packages/opentelemetry-types/README.md | 4 ++-- packages/opentelemetry-types/package.json | 2 +- 6 files changed, 19 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5375778a8f..3b841903e5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,11 +21,11 @@ for general practices for OpenTelemetry project. ### Fork -In the interest of keeping this repository clean and manageable, you should work from a fork. To create a fork, click the 'Fork' button at the top of the repository, then clone the fork locally using `git clone git@github.com:USERNAME/opentelemetry-node.git`. +In the interest of keeping this repository clean and manageable, you should work from a fork. To create a fork, click the 'Fork' button at the top of the repository, then clone the fork locally using `git clone git@github.com:USERNAME/opentelemetry-js.git`. You should also add this repository as an "upstream" repo to your local copy, in order to keep it up to date. You can add this as a remote like so: ``` -git remote add upstream https://github.com/open-telemetry/opentelemetry-node.git +git remote add upstream https://github.com/open-telemetry/opentelemetry-js.git #verify that the upstream exists git remote -v @@ -44,7 +44,7 @@ Please also see [GitHub workflow](https://github.com/open-telemetry/community/bl ### Running the tests -The `opentelemetry-node` project is written in TypeScript. +The `opentelemetry-js` project is written in TypeScript. - `yarn install` or `npm install` to install dependencies. - `yarn compile` or `npm run compile` compiles the code, checking for type errors. diff --git a/README.md b/README.md index 6bc7a4845d..ac75674678 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,20 @@ -# OpenTelemetry Node SDK - distributed tracing and stats collection framework +# OpenTelemetry - distributed tracing and stats collection framework Node Channel: [![Gitter chat][node-gitter-image]][node-gitter-url] Community Channel: [![Gitter chat][main-gitter-image]][main-gitter-url] +We'd love your help!. Use tags [up-for-grabs][up-for-grabs-issues] and +[good first issue][good-first-issues] to get started with the project. Follow +[CONTRIBUTING](CONTRIBUTING.md) guide to report issues or submit a proposal. + +## Contributing +We have a weekly SIG meeting! See the [community page](https://github.com/open-telemetry/community#nodejs-sdk) for meeting details and notes. + [main-gitter-image]: https://badges.gitter.im/open-telemetry/community.svg [main-gitter-url]: https://gitter.im/open-telemetry/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge -[node-gitter-image]: https://badges.gitter.im/open-telemetry/opentelemetry-node.svg +[node-gitter-image]: https://badges.gitter.im/open-telemetry/opentelemetry-js.svg [node-gitter-url]: https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge - -We have a weekly SIG meeting! See the [community page](https://github.com/open-telemetry/community#nodejs-sdk) for meeting details and notes. +[up-for-grabs-issues]: https://github.com/open-telemetry/OpenTelemetry-js/issues?q=is%3Aissue+is%3Aopen+label%3Aup-for-grabs +[good-first-issues]: https://github.com/open-telemetry/OpenTelemetry-js/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 diff --git a/package.json b/package.json index 986d260d83..ff16adaa67 100644 --- a/package.json +++ b/package.json @@ -14,7 +14,7 @@ "codecov": "lerna run codecov", "check": "lerna run check" }, - "repository": "open-telemetry/opentelemetry-node", + "repository": "open-telemetry/opentelemetry-js", "keywords": [ "opentelemetry", "nodejs", diff --git a/packages/opentelemetry-core/package.json b/packages/opentelemetry-core/package.json index 15cb9c7e91..394f0165e6 100644 --- a/packages/opentelemetry-core/package.json +++ b/packages/opentelemetry-core/package.json @@ -4,7 +4,7 @@ "description": "OpenTelemetry Core", "main": "build/src/index.js", "types": "build/src/index.d.ts", - "repository": "open-telemetry/opentelemetry-node", + "repository": "open-telemetry/opentelemetry-js", "scripts": { "test": "nyc ts-mocha -p ./tsconfig.json test/**/*.ts", "tdd": "yarn run test -- --watch-extensions ts --watch", diff --git a/packages/opentelemetry-types/README.md b/packages/opentelemetry-types/README.md index a338b30ff2..4bafe1247a 100644 --- a/packages/opentelemetry-types/README.md +++ b/packages/opentelemetry-types/README.md @@ -12,6 +12,6 @@ This package provides TypeScript interfaces and enums for the OpenTelemetry core Apache 2.0 - See [LICENSE][license-url] for more information. -[gitter-image]: https://badges.gitter.im/open-telemetry/opentelemetry-node.svg +[gitter-image]: https://badges.gitter.im/open-telemetry/opentelemetry-js.svg [gitter-url]: https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge -[license-url]: https://github.com/open-telemetry/opentelemetry-node/blob/master/LICENSE +[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/master/LICENSE diff --git a/packages/opentelemetry-types/package.json b/packages/opentelemetry-types/package.json index 034aaac0f4..a01f738089 100644 --- a/packages/opentelemetry-types/package.json +++ b/packages/opentelemetry-types/package.json @@ -4,7 +4,7 @@ "description": "TypeScript types for OpenTelemetry", "main": "build/src/index.js", "types": "build/src/index.d.ts", - "repository": "open-telemetry/opentelemetry-node", + "repository": "open-telemetry/opentelemetry-js", "scripts": { "build": "npm run compile", "check": "gts check",