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.

Sign up for GitHub

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

Jump to bottom

Update README.md #17

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #17

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ One to two paragraph statement about your product and what it does.

## Installation

OS X & Linux:
OS X and Linux:

```sh
npm install my-crazy-module --save
Expand Down Expand Up @@ -63,11 +63,11 @@ Distributed under the XYZ license. See ``LICENSE`` for more information.

## Contributing

1. Fork it (<https://github.com/yourname/yourproject/fork>)
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request
1. Fork it. (<https://github.com/yourname/yourproject/fork>)
2. Create your feature branch. (`git checkout -b feature/fooBar`)
3. Commit your changes. (`git commit -am 'Add some fooBar'`)
4. Push to the branch. (`git push origin feature/fooBar`)
Copy link

Choose a reason for hiding this comment

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

Why do you put full stop before parenthesis?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, if you want to dot those lines it should really be:

Text text (…).

…or perhaps even better - commas, and a period on the last.

  1. Foo,
  2. Bar,
  3. Baz.

/2¢

Copy link

@MichaelCurrin MichaelCurrin Jul 6, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Parentheses are unneeded if it is split over lines. Keep the full stop.

Example code:

2. Create your feature branch.
    ```sh
    git checkout -b feature/fooBar
    ```

Result:

  1. Create your feature branch. 
    git checkout -b feature/fooBar

5. Create a new Pull Request.

<!-- Markdown link & img dfn's -->
[npm-image]: https://img.shields.io/npm/v/datadog-metrics.svg?style=flat-square
Expand Down