Skip to content

Commit

Permalink
Update links in contributing.md (#1177)
Browse files Browse the repository at this point in the history
* Update link to keeping diffs small

Signed-off-by: wslulciuc <[email protected]>

* Add link to GitHub flow steps

Signed-off-by: wslulciuc <[email protected]>

* Update local maven cmd

Signed-off-by: wslulciuc <[email protected]>
  • Loading branch information
wslulciuc committed Apr 1, 2021
1 parent 587a470 commit b4fd80d
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ We're excited you're interested in contributing to Marquez! We'd love your help,

We feel that a welcoming community is important and we ask that you follow the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md) in all interactions with the community.

# Getting your changes approved
# Getting Your Changes Approved

Your PR must be approved and merged by a [committer](COMMITTERS.md).
Your pull request must be approved and merged by a [committer](COMMITTERS.md).

# Development

To run the entire test suite:

```bash
$ ./gradlew :api:test
$ ./gradlew test
```

You can also run individual tests for a [submodule](https://github.com/MarquezProject/marquez#modules) using the `--tests` flag:
Expand Down Expand Up @@ -65,7 +65,7 @@ $ pre-commit install
Use [`publishToMavenLocal`](https://docs.gradle.org/current/userguide/publishing_maven.html#publishing_maven:tasks) to publish artifacts to your local maven repository:

```
$ ./gradlew :api:publishToMavenLocal
$ ./gradlew publishToMavenLocal
```

# Submitting a [Pull Request](https://help.github.com/articles/about-pull-requests)
Expand All @@ -85,7 +85,7 @@ 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
* [Keep diffs small](https://kurtisnusbaum.medium.com/stacked-diffs-keeping-phabricator-diffs-small-d9964f4dcfa6) 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](#api-docs) the static `openapi.html` file.

Expand Down Expand Up @@ -149,7 +149,8 @@ Then browse to: http:https://localhost:8080
# Resources

* [How to Contribute to Open Source](https://opensource.guide/how-to-contribute)
* [Using the Fork-and-Branch Git Workflow](https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow)
* [Using the Fork-and-Branch Git Workflow](https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow)
* [Understanding the GitHub flow](https://guides.github.com/introduction/flow/)
* [Keep a Changelog](https://keepachangelog.com)
* [Code Review Developer Guide](https://google.github.io/eng-practices/review)
* [Signing Commits](https://docs.github.com/en/github/authenticating-to-github/signing-commits)

0 comments on commit b4fd80d

Please sign in to comment.