From 6fde7196d9d7412be7ae8c168b71c21dc3fb1005 Mon Sep 17 00:00:00 2001 From: Taranveer Virk Date: Thu, 22 Mar 2018 20:35:49 -0400 Subject: [PATCH] docs: update contribution guidelines link and minor fixes --- README.md | 16 +++++++-- packages/authentication/README.md | 2 +- packages/boot/README.md | 6 ++-- packages/build/README.md | 13 +++++--- packages/cli/README.md | 12 ++++--- packages/context/README.md | 3 +- packages/core/README.md | 2 +- packages/example-getting-started/README.md | 17 ++++++++++ packages/example-hello-world/README.md | 16 +++++++++ packages/example-log-extension/README.md | 15 ++++++++- packages/example-rpc-server/README.md | 16 +++++++++ packages/metadata/README.md | 38 ++++++++++------------ packages/openapi-spec-builder/README.md | 11 ++++--- packages/openapi-v3-types/README.md | 11 ++++--- packages/openapi-v3/README.md | 13 ++++---- packages/repository-json-schema/README.md | 11 ++++--- packages/repository/README.md | 2 +- packages/testlab/README.md | 4 +-- 18 files changed, 146 insertions(+), 62 deletions(-) diff --git a/README.md b/README.md index a9d3644d9e6e..e844376ded6e 100644 --- a/README.md +++ b/README.md @@ -57,19 +57,29 @@ You can join the team by posting a comment to [issue #110](https://github.com/st Raymond Feng|Miroslav Bajtos|Ritchie Martori :-:|:-:|:-: -[](http://github.com/raymondfeng)|[](http://github.com/bajtos)|[](http://github.com/ritch) +[![raymondfeng]](http://github.com/raymondfeng)|[![bajtos]](http://github.com/bajtos)|[![ritch]](http://github.com/ritch) ## Project Maintainers: ||||| |:-:|:-:|:-:|:-:| |Taranveer Virk|Biniam Admikew|Kyu Shim|Diana Lau| -|[](http://github.com/virkt25)|[](http://github.com/b-admike)|[](http://github.com/shimks)|[](http://github.com/dhmlau)| +|[![virkt25]](http://github.com/virkt25)|[![b-admike]](http://github.com/b-admike)|[](http://github.com/shimks)|[![dhmlau]](http://github.com/dhmlau)| |Janny Hou|Simon Ho|Kevin Delisle|Rand McKinney| -|[](http://github.com/jannyHou)|[](http://github.com/superkhau)|[](http://github.com/kjdelisle)|[](http://github.com/crandmck)| +|[![jannyhou]](http://github.com/jannyHou)|[![superkhau]](http://github.com/superkhau)| See [all contributors](https://github.com/strongloop/loopback-next/graphs/contributors). # License [MIT](LICENSE) + +[raymondfeng]: https://avatars0.githubusercontent.com/u/540892?v=3&s=60 +[bajtos]: https://avatars2.githubusercontent.com/u/1140553?v=3&s=60 +[ritch]: https://avatars2.githubusercontent.com/u/462228?v=3&s=60 +[b-admike]: https://avatars0.githubusercontent.com/u/13950637?v=3&s=60 +[dhmlau]: https://avatars2.githubusercontent.com/u/25489897?v=3&s=60 +[jannyhou]: https://avatars2.githubusercontent.com/u/12554153?v=3&s=60 +[superkhau]: https://avatars1.githubusercontent.com/u/1617364?v=3&s=60 +[loay]: https://avatars3.githubusercontent.com/u/1986928?v=3&s=60 +[virkt25]: https://avatars1.githubusercontent.com/u/3311536?v=3&s=60 diff --git a/packages/authentication/README.md b/packages/authentication/README.md index a6b9087ba5e6..30ff2eb95b63 100644 --- a/packages/authentication/README.md +++ b/packages/authentication/README.md @@ -208,7 +208,7 @@ For more info about passport, see [passport.js](http://passportjs.org/). ## Contributions -- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/site/DEVELOPING.md) +- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md) - [Join the team](https://github.com/strongloop/loopback-next/issues/110) ## Tests diff --git a/packages/boot/README.md b/packages/boot/README.md index 3cd20862feae..1c89ccf0dd53 100644 --- a/packages/boot/README.md +++ b/packages/boot/README.md @@ -54,7 +54,7 @@ List of Options available on BootOptions Object. |`dirs`|`string \| string[]`|Paths relative to projectRoot to look in for Artifact| |`extensions`|`string \| string[]`|File extensions to match for Artifact| |`nested`|`boolean`|Look in nested directories in `dirs` for Artifact| -|`glob`|`string`|A `glob` pattern string. This takes precendence over above 3 options (which are used to make a glob pattern).| +|`glob`|`string`|A `glob` pattern string. This takes precedence over above 3 options (which are used to make a glob pattern).| ### BootExecOptions @@ -122,11 +122,11 @@ Available Options on the `repositories` object on `BootOptions` are as follows: |`dirs`|`string \| string[]`|`['repositories']`|Paths relative to projectRoot to look in for Repository artifacts| |`extensions`|`string \| string[]`|`['.repository.js']`|File extensions to match for Repository artifacts| |`nested`|`boolean`|`true`|Look in nested directories in `dirs` for Repository artifacts| -|`glob`|`string`||A `glob` pattern string. This takes precendence over above 3 options (which are used to make a glob pattern).| +|`glob`|`string`||A `glob` pattern string. This takes precedence over above 3 options (which are used to make a glob pattern).| ## Contributions -- [Guidelines](https://github.com/strongloop/loopback-next/wiki/Contributing#guidelines) +- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md) - [Join the team](https://github.com/strongloop/loopback-next/issues/110) ## Tests diff --git a/packages/build/README.md b/packages/build/README.md index f4d236506a95..b0c80469dc36 100644 --- a/packages/build/README.md +++ b/packages/build/README.md @@ -12,7 +12,7 @@ This module contains a set of common scripts and default configurations to build These scripts first try to locate the CLI from target project dependencies and fall back to bundled ones in `@loopback/build`. -# Usage +## Basic use To use `@loopback/build` for your package: @@ -122,14 +122,19 @@ Now you run the scripts, such as: npm run build ``` -# Tests +## Contributions + +- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md) +- [Join the team](https://github.com/strongloop/loopback-next/issues/110) + +## Tests run `npm test` from the root folder. -# Contributors +## Contributors See [all contributors](https://github.com/strongloop/loopback-next/graphs/contributors). -# License +## License MIT diff --git a/packages/cli/README.md b/packages/cli/README.md index df9999e6f108..4966a6dc19ab 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -8,7 +8,7 @@ Run the following command to install the CLI. `npm install -g @loopback/cli` -## Usage +## Basic Use 1. To scaffold a LoopBack 4 application @@ -91,15 +91,19 @@ Options: --skip-install # Do not automatically install dependencies Default: false ``` +## Contributions -# Tests +- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md) +- [Join the team](https://github.com/strongloop/loopback-next/issues/110) + +## Tests run `npm test` from the root folder. -# Contributors +## Contributors See [all contributors](https://github.com/strongloop/loopback-next/graphs/contributors). -# License +## License MIT diff --git a/packages/context/README.md b/packages/context/README.md index 4ff63d8d636b..44f3b36aa52a 100644 --- a/packages/context/README.md +++ b/packages/context/README.md @@ -84,7 +84,8 @@ For additional information, please refer to the [Context page](http://loopback.i ## Contributions -IBM/StrongLoop is an active supporter of open source and welcomes contributions to our projects as well as those of the Node.js community in general. For more information on how to contribute please refer to the [Contribution Guide](https://loopback.io/doc/en/contrib/index.html). +- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md) +- [Join the team](https://github.com/strongloop/loopback-next/issues/110) ## Tests diff --git a/packages/core/README.md b/packages/core/README.md index 1ae2c622a192..fd2e46a9149d 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -67,7 +67,7 @@ dynamic configuration updates. ## Contributions -- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/DEVELOPING.md) +- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md) - [Join the team](https://github.com/strongloop/loopback-next/issues/110) ## Tests diff --git a/packages/example-getting-started/README.md b/packages/example-getting-started/README.md index 3d99125f6b97..ee2c65950bc2 100644 --- a/packages/example-getting-started/README.md +++ b/packages/example-getting-started/README.md @@ -75,3 +75,20 @@ for help with this tutorial! ### Bugs/Feedback Open an issue in [loopback-next](https://github.com/strongloop/loopback-next) and we'll take a look! + +## Contributions + +- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md) +- [Join the team](https://github.com/strongloop/loopback-next/issues/110) + +## Tests + +Run `npm test` from the root folder. + +## Contributors + +See [all contributors](https://github.com/strongloop/loopback-next/graphs/contributors). + +## License + +MIT diff --git a/packages/example-hello-world/README.md b/packages/example-hello-world/README.md index 3dce7893d452..fef22e855b14 100644 --- a/packages/example-hello-world/README.md +++ b/packages/example-hello-world/README.md @@ -47,3 +47,19 @@ npm start The application will start on port `3000`. Use your favourite browser or REST client to access any path with a GET request, and watch it return `Hello world!`. +## Contributions + +- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md) +- [Join the team](https://github.com/strongloop/loopback-next/issues/110) + +## Tests + +Run `npm test` from the root folder. + +## Contributors + +See [all contributors](https://github.com/strongloop/loopback-next/graphs/contributors). + +## License + +MIT diff --git a/packages/example-log-extension/README.md b/packages/example-log-extension/README.md index 453d48e138db..e3aea94401bd 100644 --- a/packages/example-log-extension/README.md +++ b/packages/example-log-extension/README.md @@ -426,6 +426,19 @@ extension. There are unit tests to test functionality of individual functions as well as an extension acceptance test which tests the entire extension as a whole (everything working together). +## Contributions + +- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md) +- [Join the team](https://github.com/strongloop/loopback-next/issues/110) + +## Tests + +Run `npm test` from the root folder. + +## Contributors + +See [all contributors](https://github.com/strongloop/loopback-next/graphs/contributors). + ## License -MIT License +MIT diff --git a/packages/example-rpc-server/README.md b/packages/example-rpc-server/README.md index e9842bb8910c..178e3880af65 100644 --- a/packages/example-rpc-server/README.md +++ b/packages/example-rpc-server/README.md @@ -46,3 +46,19 @@ Example: The router will determine which controller and method will service your request based on the given names in the payload. +## Contributions + +- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md) +- [Join the team](https://github.com/strongloop/loopback-next/issues/110) + +## Tests + +Run `npm test` from the root folder. + +## Contributors + +See [all contributors](https://github.com/strongloop/loopback-next/graphs/contributors). + +## License + +MIT diff --git a/packages/metadata/README.md b/packages/metadata/README.md index 47a4ea5824c0..e065716670bd 100644 --- a/packages/metadata/README.md +++ b/packages/metadata/README.md @@ -11,9 +11,9 @@ metadata, and inspect metadata. * MetadataInspector: High level APIs to inspect a class and/or its members to get metadata applied by decorators. -# Usage +## Basic Use -## To create a class decorator +### To create a class decorator ```ts import {ClassDecoratorFactory} from '@loopback/metadata'; @@ -50,7 +50,7 @@ Now we can use `@myClassDecorator` to add metadata to a class as follows: class MyController {} ``` -## To create a method decorator +### To create a method decorator ```ts import {MethodDecoratorFactory} from '@loopback/metadata'; @@ -85,7 +85,7 @@ class MyController { } ``` -## To create a property decorator +### To create a property decorator ```ts import {PropertyDecoratorFactory} from '@loopback/metadata'; @@ -118,7 +118,7 @@ class MyController { } ``` -## To create a parameter decorator +### To create a parameter decorator ```ts import {ParameterDecoratorFactory} from '@loopback/metadata'; @@ -163,7 +163,7 @@ class MyController { } ``` -## To create method decorator for parameters +### To create method decorator for parameters ```ts import {MethodParameterDecoratorFactory} from '@loopback/metadata'; @@ -194,6 +194,7 @@ class MyController { x: number, y: number, ) {} +} ``` **WARNING**: Using method decorators to provide metadata for parameters is @@ -204,7 +205,7 @@ strongly discouraged for a few reasons: We recommend that `ParameterDecorator` be used instead. -## Decorator options +### Decorator options An object of type `DecoratorOptions` can be passed in to create decorator functions. There are two flags for the options: @@ -215,7 +216,7 @@ Sometimes we use shared spec for the decoration, but the decorator function might need to mutate the object. Cloning the input spec makes it safe to use the same spec (`template`) to decorate different members. Default to `true`. -## Customize inheritance of metadata +### Customize inheritance of metadata By default, the decorator factories allow inheritance with the following rules: @@ -320,12 +321,12 @@ For example, the following usage will report an error at runtime. class MyController {} ``` -## Inspect metadata +### Inspect metadata `MetadataInspector` provides API to inspect metadata from a class and its members. -## Inspect metadata of a class +### Inspect metadata of a class ```ts import {MetadataInspector} from '@loopback/metadata'; @@ -350,7 +351,7 @@ const meta = MetadataInspector.getClassMetadata( ); ``` -## Inspect metadata of a method +### Inspect metadata of a method ```ts import {MetadataInspector} from '@loopback/metadata'; @@ -367,7 +368,7 @@ const myMethod = MetadataInspector.getMethodMetaData( ); ``` -## Inspect metadata of a property +### Inspect metadata of a property ```ts import {MetadataInspector} from '@loopback/metadata'; @@ -384,7 +385,7 @@ const myProp = MetadataInspector.getMethodMetaData( ); ``` -## Inspect metadata of method parameters +### Inspect metadata of method parameters ```ts import {MetadataInspector} from '@loopback/metadata'; @@ -412,7 +413,7 @@ const allParamsForConstructor = ); ``` -## Inspect design-time metadata of properties/methods +### Inspect design-time metadata of properties/methods ```ts import {MetadataInspector} from '@loopback/metadata'; @@ -441,10 +442,8 @@ $ npm install --save @loopback/metadata ## Contributions -IBM/StrongLoop is an active supporter of open source and welcomes contributions -to our projects as well as those of the Node.js community in general. For more -information on how to contribute please refer to the -[Contribution Guide](https://loopback.io/doc/en/contrib/index.html). +- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md) +- [Join the team](https://github.com/strongloop/loopback-next/issues/110) ## Tests @@ -452,8 +451,7 @@ Run `npm test` from the root folder. ## Contributors -See -[all contributors](https://github.com/strongloop/loopback-next/graphs/contributors). +See [all contributors](https://github.com/strongloop/loopback-next/graphs/contributors). ## License diff --git a/packages/openapi-spec-builder/README.md b/packages/openapi-spec-builder/README.md index 8ad58a5eae87..87af8d3d0587 100644 --- a/packages/openapi-spec-builder/README.md +++ b/packages/openapi-spec-builder/README.md @@ -74,16 +74,17 @@ of OpenAPI Specification. ## Contributions -IBM/StrongLoop is an active supporter of open source and welcomes contributions to our projects as well as those of the Node.js community in general. For more information on how to contribute please refer to the [Contribution Guide](https://loopback.io/doc/en/contrib/index.html). +- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md) +- [Join the team](https://github.com/strongloop/loopback-next/issues/110) -# Tests +## Tests -run `npm test` from the root folder. +Run `npm test` from the root folder. -# Contributors +## Contributors See [all contributors](https://github.com/strongloop/loopback-next/graphs/contributors). -# License +## License MIT diff --git a/packages/openapi-v3-types/README.md b/packages/openapi-v3-types/README.md index 23f266c2591d..88c16b116372 100644 --- a/packages/openapi-v3-types/README.md +++ b/packages/openapi-v3-types/README.md @@ -36,16 +36,17 @@ For the types missing in this package, they are exported from https://www.npmjs. ## Contributions -IBM/StrongLoop is an active supporter of open source and welcomes contributions to our projects as well as those of the Node.js community in general. For more information on how to contribute please refer to the [Contribution Guide](https://loopback.io/doc/en/contrib/index.html). +- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md) +- [Join the team](https://github.com/strongloop/loopback-next/issues/110) -# Tests +## Tests -run `npm test` from the root folder. +Run `npm test` from the root folder. -# Contributors +## Contributors See [all contributors](https://github.com/strongloop/loopback-next/graphs/contributors). -# License +## License MIT diff --git a/packages/openapi-v3/README.md b/packages/openapi-v3/README.md index b234b14a3b8d..d0d30e709b11 100644 --- a/packages/openapi-v3/README.md +++ b/packages/openapi-v3/README.md @@ -62,16 +62,17 @@ of OpenAPI Specification. ## Contributions -IBM/StrongLoop is an active supporter of open source and welcomes contributions to our projects as well as those of the Node.js community in general. For more information on how to contribute please refer to the [Contribution Guide](https://loopback.io/doc/en/contrib/index.html). +- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md) +- [Join the team](https://github.com/strongloop/loopback-next/issues/110) -# Tests +## Tests -run `npm test` from the root folder. +Run `npm test` from the root folder. -# Contributors +## Contributors See [all contributors](https://github.com/strongloop/loopback-next/graphs/contributors). -# License +## License -MIT \ No newline at end of file +MIT diff --git a/packages/repository-json-schema/README.md b/packages/repository-json-schema/README.md index 94e59f249934..a89c1c77d63d 100644 --- a/packages/repository-json-schema/README.md +++ b/packages/repository-json-schema/README.md @@ -41,16 +41,17 @@ The value of `jsonSchema` will be: ## Contributions -IBM/StrongLoop is an active supporter of open source and welcomes contributions to our projects as well as those of the Node.js community in general. For more information on how to contribute please refer to the [Contribution Guide](https://loopback.io/doc/en/contrib/index.html). +- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md) +- [Join the team](https://github.com/strongloop/loopback-next/issues/110) -# Tests +## Tests -run `npm test` from the root folder. +Run `npm test` from the root folder. -# Contributors +## Contributors See [all contributors](https://github.com/strongloop/loopback-next/graphs/contributors). -# License +## License MIT diff --git a/packages/repository/README.md b/packages/repository/README.md index a6e8a3d514b2..578e6366764b 100644 --- a/packages/repository/README.md +++ b/packages/repository/README.md @@ -320,7 +320,7 @@ coercion. The following types are supported out of box. ## Tests -run `npm test` from the root folder. +Run `npm test` from the root folder. ## Contributors diff --git a/packages/testlab/README.md b/packages/testlab/README.md index 3125ad87165b..bfcb39894acf 100644 --- a/packages/testlab/README.md +++ b/packages/testlab/README.md @@ -73,12 +73,12 @@ For more info about `supertest`, please refer to [supertest](https://www.npmjs.c ## Contributions -- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/DEVELOPING.md) +- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md) - [Join the team](https://github.com/strongloop/loopback-next/issues/110) ## Tests -run 'npm test' from the root folder. +Run `npm test` from the root folder. ## Contributors