Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wslulciuc committed Aug 27, 2019
1 parent 8fa03ee commit b2257e7
Showing 1 changed file with 21 additions and 21 deletions.
42 changes: 21 additions & 21 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ We use [spotless](https://github.com/diffplug/spotless) to format our code. This
$ ./gradlew spotlessApply
```

> **Note:** To make formatting code simple, we recommend installing a [plugin](https://github.com/google/google-java-format#intellij-android-studio-and-other-jetbrains-ides) for your favorite IDE. We also us [Lombok](https://projectlombok.org). Though not required, you might want to install the [plugin](https://projectlombok.org/setup/overview) as well.
> **Note:** To make formatting code simple, we recommend installing a [plugin](https://github.com/google/google-java-format#intellij-android-studio-and-other-jetbrains-ides) for your favorite IDE. We also us [Lombok](https://projectlombok.org). Though not required, you might want to install the [plugin](https://projectlombok.org/setup/overview) as well.
# Submitting a [Pull Request](https://help.github.com/articles/about-pull-requests)

Expand All @@ -58,26 +58,26 @@ To ensure your pull request is accepted, follow these guidelines:
* All changes should be accompanied by tests
* Do your best to have a [well-formed commit message](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) for your change
* [Keep diffs small](https://graysonkoonce.com/stacked-pull-requests-keeping-github-diffs-small) and self-contained
* If your change fixes a bug, please [link the issue](https://help.github.com/articles/closing-issues-using-keywords) in your pull request description
* Any changes to the API reference requires [regenerating](#docs) the static `openapi.html` file.

# [Docs](https://github.com/MarquezProject/marquez/tree/master/docs)

> **Note:** To bundle or serve the API reference, please install [`redoc-cli`](https://www.npmjs.com/package/redoc-cli).
To bundle:

```bash
$ redoc-cli bundle docs/openapi.yml -o docs/openapi.html --title "Marquez API Reference"
```

To serve:

```bash
$ redoc-cli serve docs/openapi.yml
```

Then browse to: http:https://localhost:8080
* If your change fixes a bug, please [link the issue](https://help.github.com/articles/closing-issues-using-keywords) in your pull request description
* Any changes to the API reference requires [regenerating](#docs) the static `openapi.html` file.

# [Docs](https://github.com/MarquezProject/marquez/tree/master/docs)

To bundle:

```bash
$ redoc-cli bundle docs/openapi.yml -o docs/openapi.html --title "Marquez API Reference"
```

To serve:

```bash
$ redoc-cli serve docs/openapi.yml
```

Then browse to: http:https://localhost:8080

> **Note:** To bundle or serve the API reference, please install [`redoc-cli`](https:https://www.npmjs.com/package/redoc-cli).
# Resources

Expand Down

0 comments on commit b2257e7

Please sign in to comment.