Skip to content

Commit

Permalink
📖 revert PAT scope change and document Go resources (#4003)
Browse files Browse the repository at this point in the history
* undo pat scope doc change

Signed-off-by: Spencer Schrock <sschrock@google.com>

* add Go resources

some contributors may be unfamiliar with the language

Signed-off-by: Spencer Schrock <sschrock@google.com>

---------

Signed-off-by: Spencer Schrock <sschrock@google.com>
  • Loading branch information
spencerschrock committed Apr 8, 2024
1 parent b118c19 commit 4c6d0e5
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ project. This document describes the contribution guidelines for the project.
* [Contributing code](#contributing-code)
* [Getting started](#getting-started)
* [Environment Setup](#environment-setup)
* [New to Go?](#new-to-go)
* [Contributing steps](#contributing-steps)
* [How to build scorecard locally](#how-to-build-scorecard-locally)
* [PR Process](#pr-process)
Expand Down Expand Up @@ -62,6 +63,15 @@ You may need these tools for some tasks:

1. [`docker`](https://docs.docker.com/engine/install/): `v18.9` or higher.

### New to Go?

If you're unfamiliar with the language, there are plenty of articles, resources, and books.
We recommend starting with several resources from the official Go website:

* [How to Write Go Code](https://go.dev/doc/code)
* [A Tour of Go](https://go.dev/tour/)
* [Effective Go](https://go.dev/doc/effective_go)

## Contributing steps

1. Identify an existing issue you would like to work on, or submit an issue describing your proposed change to the repo in question.
Expand Down Expand Up @@ -180,7 +190,9 @@ make fix-linter

## Permission for GitHub personal access tokens

For public repos, classic personal access tokens do not need any scopes.
For public repos, classic personal access tokens need the following scopes:

- `public_repo` - Read/write access to public repositories. Needed for branch protection

## Where the CI Tests are configured

Expand Down

0 comments on commit 4c6d0e5

Please sign in to comment.