-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add a contributing guide (#90)
- Loading branch information
Showing
2 changed files
with
54 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters