ossf/scorecard
1
1
Fork 0
mirror of https://github.com/ossf/scorecard.git synced 2024-11-04 03:52:31 +03:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

feature - Update the CONTRIBUTING guidelines

Browse Source 
* Updated the contributing guidelines with Environment Setup,
Contributing steps, How to build scorecard locally, What to do before
submitting a pull request and Where the CI Tests are configured.

Signed-off-by: naveen <172697+naveensrinivasan@users.noreply.github.com>
This commit is contained in:
naveen 2021-01-04 12:09:21 -05:00
parent b216a1e494
commit c5c51b9977
1 changed files with 32 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
CONTRIBUTING.md
View File

@ -1,4 +1,4 @@
# Contributing to Security Scorecards!
# Contributing to Security Scorecards
Thank you for contributing your time and expertise to the Security Scorecards project.
This document describes the contribution guidelines for the project.
@ -9,40 +9,52 @@ This document describes the contribution guidelines for the project.
### Getting started
1. Create [a GitHub account](https://github.com/join)
1. Create a [personal access token](https://docs.github.com/en/free-pro-team@latest/developers/apps/about-apps#personal-access-tokens)
1. Set up your [development environment](#environment-setup)
1. Create [a GitHub account](https://github.com/join)
1. Create a [personal access token](https://docs.github.com/en/free-pro-team@latest/developers/apps/about-apps#personal-access-tokens)
1. Set up your [development environment](#environment-setup)
Then you can [iterate](#iterating).
### Environment Setup
You must install these tools:
1. [`git`](https://help.github.com/articles/set-up-git/): For source control
1. [`git`](https://help.github.com/articles/set-up-git/): For source control
1. [`go`](https://golang.org/doc/install): The language Tekton Pipelines is
built in. You need go version [v1.15](https://golang.org/dl/) or higher.
1. [`go`](https://golang.org/doc/install): You need go version [v1.15](https://golang.org/dl/) or higher.
## Iterating
1. [`docker`](https://docs.docker.com/engine/install/): `v18.9` or higher.
You can build the project with:
## Contributing steps
1. Submit an issue describing your proposed change to the repo in question.
1. The repo owners will respond to your issue promptly.
1. Fork the desired repo, develop and test your code changes.
1. Submit a pull request.
## How to build scorecard locally
Note that, by building the scorecard from the source code we are allowed to test the changes made locally.
1. Run the following command to clone your fork of the project locally
```shell
go build .
git clone git@github.com:<user>/scorecard.git $GOPATH/src/github.com/<user>/scorecard.git
```
You can also use `go run` to iterate without a separate rebuild step:
1. Ensure you activate module support before continue (`$ export GO111MODULE=on`)
1. Run the command `make build` to build the source code
```shell
go run . --repo=<repo>
```
## What to do before submitting a pull request
You can run tests with:
Following the targets that can be used to test your changes locally.
```shell
go test .
```
| Command | Description | Is called in the CI? |
| ---------- | --------------------------------------------------- | -------------------- |
| make all | Runs go test,golangci lint checks, fmt, go mod tidy | yes |
| make build | Runs go build | yes |
## Where the CI Tests are configured
1. See the [action files](.github/workflows) to check its tests, and the scripts used on it.
## Adding New Checks