Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📖 revert PAT scope change and document Go resources #4003

Merged
merged 2 commits into from
Apr 8, 2024
Merged

📖 revert PAT scope change and document Go resources #4003

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3637a7
undo pat scope doc change
spencerschrock Apr 4, 2024
1b692dd
add Go resources
spencerschrock Apr 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 13 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
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