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

Conversation

virkt25
Copy link
Contributor

@virkt25 virkt25 commented Mar 23, 2018

connected to #988

  • Noticed different links for Contribution guidelines in different packages, so this fixes that.
  • Changes main README to use references for images in table
  • quick typo fix
  • Add Last 4 section to packages missing that information (examples)

Checklist

  • npm test passes on your machine
  • New tests added or existing tests modified to cover all changes
  • Code conforms with the style guide
  • API Documentation in code was updated
  • Documentation in /docs/site was updated
  • Affected artifact templates in packages/cli were updated
  • Affected example projects in packages/example-* were updated

@virkt25 virkt25 added this to the March 2018 milestone Mar 23, 2018
@virkt25 virkt25 self-assigned this Mar 23, 2018
@virkt25 virkt25 requested a review from a team March 23, 2018 00:40
Copy link
Member

@bajtos bajtos left a comment

Choose a reason for hiding this comment

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

Changes look good in principle, I have two comments to consider. No further review is needed as far as I am concerned.

README.md Outdated
|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)|[![kjdelisle]](http://github.com/kjdelisle)|[![crandmck]](http://github.com/crandmck)|
Copy link
Member

Choose a reason for hiding this comment

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

Please remove both kjdelisle and crandmck, they are no longer maintaining the project.

@@ -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
## Usage
Copy link
Member

Choose a reason for hiding this comment

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

FWIW, according to our README guidelines, the correct name for this section is Basic use.

@virkt25 virkt25 force-pushed the docs/contributing-link branch from 6a09fa6 to e3599cb Compare March 23, 2018 15:26
Copy link
Contributor

@shimks shimks left a comment

Choose a reason for hiding this comment

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

A closing bracket is missing and it messes with the way github parses the code snippet and the readme itself

@@ -204,7 +204,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

@virkt25 virkt25 force-pushed the docs/contributing-link branch from d3842d4 to 2265034 Compare March 23, 2018 16:46
@virkt25 virkt25 force-pushed the docs/contributing-link branch from 2265034 to 6fde719 Compare March 23, 2018 17:27
@virkt25 virkt25 merged commit da2fd48 into master Mar 23, 2018
@virkt25 virkt25 deleted the docs/contributing-link branch March 23, 2018 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants