Skip to content

[+] add SECURITY.md and CONTRIBUTING.md, fix the service unit - #428

Open
pashagolub wants to merge 2 commits into
masterfrom
chore/project-hygiene
Open

pashagolub wants to merge 2 commits into
masterfrom
chore/project-hygiene

Conversation

@pashagolub

Copy link
Copy Markdown
Collaborator
  • SECURITY.md: vip-manager runs as root, opens raw sockets and holds DCS and
    Hetzner API credentials, so it should say where to report a finding instead
    of having it end up in the public issue tracker. Reporting goes through
    GitHub's private advisories, no new mailbox needed.

  • CONTRIBUTING.md: how to build, test and lint, which tests are skipped
    without Docker or root, and the commit subject convention of this
    repository.

  • vip-manager.service: After=network-online.target does not pull the target
    in on its own, the unit needs a Wants= for the ordering to have any effect.

  • README: the prerequisite said go >= 1.19 while go.mod asks for 1.26.

  • gofmt over two test files that were left with trailing whitespace.

@pashagolub pashagolub self-assigned this Sep 14, 2026
* SECURITY.md: vip-manager runs as root, opens raw sockets and holds DCS and
  Hetzner API credentials, so it should say where to report a finding instead
  of having it end up in the public issue tracker. Reporting goes through
  GitHub's private advisories, no new mailbox needed.

* CONTRIBUTING.md: how to build, test and lint, which tests are skipped
  without Docker or root, and the commit subject convention of this
  repository.

* vip-manager.service: After=network-online.target does not pull the target
  in on its own, the unit needs a Wants= for the ordering to have any effect.

* README: the prerequisite said go >= 1.19 while go.mod asks for 1.26.

* gofmt over two test files that were left with trailing whitespace.
Embedding both the configuration and the etcd client put their methods and
fields into one namespace: elc.Get() and elc.Close() silently belonged to the
client, elc.Logger to the configuration, and any name the two come to share in
a future release of either would break the build far away from the cause. The
tests reached through the same promotion, which is how a test ended up calling
the Close() of the client.

No behaviour change. The consul and the patroni checker embed their client the
same way and can follow if this direction is welcome.
@pashagolub
pashagolub force-pushed the chore/project-hygiene branch from 312ec80 to e1b5cf5 Compare September 14, 2026 15:24
@coveralls

Copy link
Copy Markdown

Coverage Status

coverage: 92.075% (-0.08%) from 92.15% — chore/project-hygiene into master

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants