gaper/CONTRIBUTING.md

61 lines
1.1 KiB
Markdown
Raw Normal View History

2018-06-16 19:22:21 -05:00
# Contributing to httpfake
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
There are few ways of contributing to gaper
* Report an issue.
* Contribute to the code base.
## Report an issue
* Before opening the issue make sure there isn't an issue opened for the same problem
* Include the Go and Gaper version you are using
* If it is a bug, please include all info to reproduce the problem
## Contribute to the code base
### Pull Request
* Please discuss the suggested changes on a issue before working on it. Just to make sure the change makes sense before you spending any time on it.
### Setupping development
```
make setup
```
### Running gaper in development
```
make build && \
./gaper \
--verbose \
--bin-name srv \
--build-path ./testdata/server \
2022-08-07 08:30:58 -05:00
--build-args="-ldflags=\"-X 'main.Version=v1.0.0'\"" \
--extensions "go,txt"
2018-06-16 19:22:21 -05:00
```
### Running lint
```
make lint
```
### Running tests
All tests:
```
make test
```
A single test:
```
go test -run TestSimplePost ./...
```
2022-08-08 09:14:30 -05:00
### Release
The release runs automatically with a Github action on pushed git tags.