Skip to content

Commit

Permalink
Merge pull request #24 from omc/doc/extract-contributing-to-contribut…
Browse files Browse the repository at this point in the history
…ing-md

Move README#Contributing to CONTRIBUTING.md
  • Loading branch information
momer authored May 6, 2024
2 parents 7941692 + 6c8397b commit f434c96
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 18 deletions.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contributing

## Pre-commit

This project uses [pre-commit](https://pre-commit.com/) to lint and store 3rd-party dependency licenses.
Installation instructions are available on the [pre-commit](https://pre-commit.com/) website!

To verify your installation, run this project's pre-commit hooks against all files:

```shell
pre-commit run --all-files
```

### Go-licenses pre-commit hook

Windows users: Ensure that you have `C:\Program Files\Git\usr\bin` added
to your `PATH`!
18 changes: 0 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,21 +63,3 @@ func main() {
log.Printf("Found %d clusters! Details: %v\n", len(clusters), clusters)
}
```

## Contributing

### Pre-commit

This project uses [pre-commit](https://pre-commit.com/) to lint and store 3rd-party dependency licenses.
Installation instructions are available on the [pre-commit](https://pre-commit.com/) website!

To verify your installation, run this project's pre-commit hooks against all files:

```shell
pre-commit run --all-files
```

#### Go-licenses pre-commit hook

Windows users: Ensure that you have `C:\Program Files\Git\usr\bin` added
to your `PATH`!

0 comments on commit f434c96

Please sign in to comment.