From 4c6d0e53a3e8585b35dbc3ee7b9a0ab677cfed70 Mon Sep 17 00:00:00 2001 From: Spencer Schrock Date: Mon, 8 Apr 2024 08:37:04 -0700 Subject: [PATCH] :book: revert PAT scope change and document Go resources (#4003) * undo pat scope doc change Signed-off-by: Spencer Schrock * add Go resources some contributors may be unfamiliar with the language Signed-off-by: Spencer Schrock --------- Signed-off-by: Spencer Schrock --- CONTRIBUTING.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 56fe09892d1..427ecffa7b3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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) @@ -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. @@ -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