Skip to content

Commit

Permalink
📖 Add package comments. (#1221)
Browse files Browse the repository at this point in the history
* Add package comments.

---------

Signed-off-by: Spencer Schrock <sschrock@google.com>
Signed-off-by: Stephen Augustus <justaugustus@users.noreply.github.com>
Co-authored-by: Stephen Augustus <justaugustus@users.noreply.github.com>
  • Loading branch information
spencerschrock and justaugustus authored Jul 19, 2023
1 parent 3f76786 commit fc268b1
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 0 deletions.
1 change: 1 addition & 0 deletions entrypoint/entrypoint.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 (
Expand Down
1 change: 1 addition & 0 deletions github/github.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 (
Expand Down
1 change: 1 addition & 0 deletions install/cli/cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
//
// SPDX-License-Identifier: Apache-2.0

// Package cli contains the root CLI command.
package cli

import (
Expand Down
1 change: 1 addition & 0 deletions install/github/github.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
//
// SPDX-License-Identifier: Apache-2.0

// Package github interacts with GitHub repos and orgs.
package github

import (
Expand Down
1 change: 1 addition & 0 deletions install/install.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
//
// SPDX-License-Identifier: Apache-2.0

// Package install contains functionality to install the OpenSSF Scorecard workflow.
package install

import (
Expand Down
1 change: 1 addition & 0 deletions install/options/options.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
//
// SPDX-License-Identifier: Apache-2.0

// Package options provides installation options for the scorecard action.
package options

import (
Expand Down
1 change: 1 addition & 0 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 (
Expand Down

0 comments on commit fc268b1

Please sign in to comment.