Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

70 lines (48 loc) · 2.34 KB
Raw

Contributing to OSS Criticality Score!

Thank you for contributing your time and expertise to the OSS Criticality Score project. This document describes the contribution guidelines for the project.

Note: Before you start contributing, you must read and abide by our Code of Conduct.

Contributing code

Getting started

  1. Create a GitHub account
  2. Create a personal access token
  3. (Optionally) a Google Cloud Platform account for deps.dev data
  4. Set up your development environment

Then you can iterate.

Environment Setup

You must install these tools:

  1. git: For source control.

  2. go: For running code.

And optionally:

  1. gcloud: For Google Cloud Platform access for deps.dev data.

Then clone the repository, e.g:

$ git clone git@github.com:ossf/criticality_score.git
$ cd criticality_score

Iterating

  1. Find or create an issue

  2. Make code changes to:

  3. Run your changes. For example, for a single repository this can be done by executing:

$ export GITHUB_TOKEN=ghp_x  # the personal access token created above
$ go run ./cmd/criticality_score \
    -log=debug \
    -depsdev-disable \  # remove if you have a GCP account configured
    "https://github.com/{ a repo }"

Note: Each of the tools listed above can be run individually and has their own README.

  1. Ensure your code passes tests and lint checks:
$ make test
$ make lint
  1. Commit your change. Upload to a fork, and create a pull request!