elastic / elastic/apm-server

Add a package comment for every package, and enable staticcheck's ST1000

Open
#8,700 0 comments 0 reactions 0 assignees View on GitHub
8.6-candidate enhancement technical debt
Dominant language
Go
Stars
1.3k
Forks
543
Avg merge
1d 18h
Merged PRs (30d)
109

Description

In https://github.com/elastic/apm-server/pull/8680 we have enabled all checks in staticcheck except for [ST1000](https://staticcheck.io/docs/checks#ST1000) (Incorrect or missing package comment), as many of our packages lack package comments.

We should introduce a package comment for all packages, and enable ST1000. This should help ensure that we're a bit more intentional about the meaning of packages and how code is organised.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.