Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update contribution guidelines link and minor fixes #1178

Merged
merged 1 commit into from
Mar 23, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
:-:|:-:|:-:
[<img src="https://avatars0.githubusercontent.com/u/540892?v=3&s=60">](http://github.com/raymondfeng)|[<img src="https://avatars2.githubusercontent.com/u/1140553?v=3&s=60">](http://github.com/bajtos)|[<img src="https://avatars2.githubusercontent.com/u/462228?v=3&s=60">](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|
|[<img src="https://avatars1.githubusercontent.com/u/3311536?v=3&s=60">](http://github.com/virkt25)|[<img src="https://avatars0.githubusercontent.com/u/13950637?v=3&s=60">](http://github.com/b-admike)|[<img src="https://avatars3.githubusercontent.com/u/18518689?v=3&s=60" height=60>](http://github.com/shimks)|[<img src="https://avatars2.githubusercontent.com/u/25489897?v=3&s=60">](http://github.com/dhmlau)|
|[![virkt25]](http://github.com/virkt25)|[![b-admike]](http://github.com/b-admike)|[<img src="https://avatars3.githubusercontent.com/u/18518689?v=3&s=60" height=60>](http://github.com/shimks)|[![dhmlau]](http://github.com/dhmlau)|
|Janny Hou|Simon Ho|Kevin Delisle|Rand McKinney|
|[<img src="https://avatars2.githubusercontent.com/u/12554153?v=3&s=60">](http://github.com/jannyHou)|[<img src="https://avatars1.githubusercontent.com/u/1617364?v=3&s=60">](http://github.com/superkhau)|[<img src="https://avatars3.githubusercontent.com/u/2053534?v=3&s=60">](http://github.com/kjdelisle)|[<img src="https://avatars2.githubusercontent.com/u/2925364?v=3&s=60">](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
2 changes: 1 addition & 1 deletion packages/authentication/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions packages/boot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down
13 changes: 9 additions & 4 deletions packages/build/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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
12 changes: 8 additions & 4 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
3 changes: 2 additions & 1 deletion packages/context/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
17 changes: 17 additions & 0 deletions packages/example-getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
16 changes: 16 additions & 0 deletions packages/example-hello-world/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
15 changes: 14 additions & 1 deletion packages/example-log-extension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
16 changes: 16 additions & 0 deletions packages/example-rpc-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
38 changes: 18 additions & 20 deletions packages/metadata/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -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';
Expand Down Expand Up @@ -85,7 +85,7 @@ class MyController {
}
```

## To create a property decorator
### To create a property decorator

```ts
import {PropertyDecoratorFactory} from '@loopback/metadata';
Expand Down Expand Up @@ -118,7 +118,7 @@ class MyController {
}
```

## To create a parameter decorator
### To create a parameter decorator

```ts
import {ParameterDecoratorFactory} from '@loopback/metadata';
Expand Down Expand Up @@ -163,7 +163,7 @@ class MyController {
}
```

## To create method decorator for parameters
### To create method decorator for parameters

```ts
import {MethodParameterDecoratorFactory} from '@loopback/metadata';
Expand Down Expand Up @@ -194,6 +194,7 @@ class MyController {
x: number,
y: number,
) {}
}
```

**WARNING**: Using method decorators to provide metadata for parameters is
Expand All @@ -204,7 +205,7 @@ strongly discouraged for a few reasons:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 197: missing a close bracket here

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:
Expand All @@ -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:

Expand Down Expand Up @@ -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';
Expand All @@ -350,7 +351,7 @@ const meta = MetadataInspector.getClassMetadata<MyClassMetaData>(
);
```

## Inspect metadata of a method
### Inspect metadata of a method

```ts
import {MetadataInspector} from '@loopback/metadata';
Expand All @@ -367,7 +368,7 @@ const myMethod = MetadataInspector.getMethodMetaData<MyMethodMetadata>(
);
```

## Inspect metadata of a property
### Inspect metadata of a property

```ts
import {MetadataInspector} from '@loopback/metadata';
Expand All @@ -384,7 +385,7 @@ const myProp = MetadataInspector.getMethodMetaData<MyMethodMetadata>(
);
```

## Inspect metadata of method parameters
### Inspect metadata of method parameters

```ts
import {MetadataInspector} from '@loopback/metadata';
Expand Down Expand Up @@ -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';
Expand Down Expand Up @@ -441,19 +442,16 @@ $ 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

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

Expand Down
Loading