1. Contributing

1.1. Where to contribute

In general, all Hockeypuck projects are maintained under the hockeypuck organization, in the following Github projects:

1.1.1. Hockeypuck Server

The main Hockeypuck repo at github.com/hockeypuck/hockeypuck contains the source code for the Hockeypuck server, along with its helper utilities.

1.1.1.1. Hockeypuck Front-End

A fork of Matt Rude's pgpkeyserver-lite front end is included in the Hockeypuck release for convenience.

1.1.2. Hockeypuck Documentation

This website is maintained via github at github.com/hockeypuck/hockeypuck.github.io. It is the primary source of documentation for the Hockeypuck project.

1.2. Tools

1.2.1. Github CI

Pull requests are tested using the github CI. CI tasks are configured in `.github/workflows` under the main branch of the hockeypuck project.

1.3. Pull request guidelines

Github pull requests will be reviewed on merit of relevance to the project goals. Significant feature development should be discussed first on the mailing list.

In code reviews, I'll look and ask for:

• Correctness. Does it do what it claims to?
• Succinct and appropriate naming.
• General Go style (Effective Go, etc.) and codebase fit. When in doubt, ask.
• Godoc comments on public symbols (an area I'd like to improve)
• Adequate test coverage (ditto)

Authors