mirror of
https://github.com/WireGuard/wgctrl-go.git
synced 2024-11-11 11:39:17 +00:00
97bc4ad4a1
* internal/freebsd: add initial version of FreeBSD support * internal/wguser: Replace deprecated io/ioutil package with io * internal/freebsd: prepare CI to run tests on FreeBSD * test: sort AllowedIPs before diffing them * test: skip integration test configure_peers_update_only on FreeBSD * test: increase test timeout for slow FreeBSD tests * add FreeBSD support to README Signed-off-by: Steffen Vogel <post@steffenvogel.de> * *: tidy * go.mod: bump dependencies * .builds: try to fix OpenBSD Signed-off-by: Matt Layher <mdlayher@gmail.com> Co-authored-by: Steffen Vogel <post@steffenvogel.de>
23 lines
886 B
Markdown
23 lines
886 B
Markdown
# Contributing
|
|
|
|
The `wgctrl` project makes use of the [GitHub Flow](https://guides.github.com/introduction/flow/)
|
|
for contributions.
|
|
|
|
If you'd like to contribute to the project, please
|
|
[open an issue](https://github.com/WireGuard/wgctrl-go/issues/new) or find an
|
|
[existing issue](https://github.com/WireGuard/wgctrl-go/issues) that you'd like
|
|
to take on. This ensures that efforts are not duplicated, and that a new feature
|
|
aligns with the focus of the rest of the repository.
|
|
|
|
Once your suggestion has been submitted and discussed, please be sure that your
|
|
code meets the following criteria:
|
|
|
|
- code is completely `gofmt`'d
|
|
- new features or codepaths have appropriate test coverage
|
|
- `go test ./...` passes
|
|
- `go vet ./...` passes
|
|
- `staticcheck ./...` passes
|
|
- `golint ./...` returns no warnings, including documentation comment warnings
|
|
|
|
Finally, submit a pull request for review!
|