Skip to content

Commit

Permalink
docs: add a contributing guide (#90)
Browse files Browse the repository at this point in the history
  • Loading branch information
nicks authored Jan 11, 2021
1 parent b719c05 commit 0edc8bf
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 1 deletion.
53 changes: 53 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Hacking on ctlptl

So you want to make a change to `ctlptl`!

## Contributing

We welcome contributions, either as bug reports, feature requests, or pull requests.

We want everyone to feel at home in this repo and its environs; please see our
[**Code of Conduct**](https://docs.tilt.dev/code_of_conduct.html) for some rules
that govern everyone's participation.

## Commands

Most of the commands for building and testing `ctlptl` should be familiar
with anyone used to developing in Golang. But we have a Makefile to wrap
common commands.

### Run

```
go run ./cmd/ctlptl
```

### Install dev version

```
make install
```

### Unit tests

```
make test
```

### Integration tests

```
make e2e
```

### Release

CircleCI will automatically build ctlptl releases when you push
a new tag to master.

```
git pull origin main
git fetch --tags
git tag -a v0.x.y -m "v0.x.y"
git push origin v0.x.y
```
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ cluster](https://docs.tilt.dev/choosing_clusters.html) and example repos like

`ctlptl` is a work in progress!

We welcome contributions from the Kubernetes community to help make this better.
We welcome [contributions](CONTRIBUTING.md) from the Kubernetes community to help make this better.

We expect everyone -- users, contributors, followers, and employees alike -- to abide by our [**Code of Conduct**](CODE_OF_CONDUCT.md).

Expand Down

0 comments on commit 0edc8bf

Please sign in to comment.