📖 Add package comments.

entrypoint/entrypoint.go

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package entrypoint provides functionality to run Scorecard.
 package entrypoint
 
 import (

github/github.go

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package github provides repo information from GitHub.
 package github
 
 import (

install/cli/cli.go

@@ -14,6 +14,7 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
+// Package cli contains the root CLI command.
 package cli
 
 import (

install/github/github.go

@@ -14,6 +14,7 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
+// Package github interacts with GitHub repos and orgs.
 package github
 
 import (

install/install.go

@@ -14,6 +14,7 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
+// Package install contains functionality to install the OpenSSF Scorecard workflow.
 package install
 
 import (

install/options/options.go

@@ -14,6 +14,7 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
+// Package options provides installation options for the scorecard action.
 package options
 
 import (

main.go

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Command scorecard-action is the entrypoint for the Scorecard GitHub Action.
 package main
 
 import (