Skip to content

Latest commit

 

History

History
43 lines (25 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

43 lines (25 loc) · 1.27 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. Set up your development environment

Then you can iterate.

Environment Setup

You must install these tools:

  1. git: For source control.

  2. python: For running code.

  3. python-gitlab and PyGithub pip packages.

pip3 install python-gitlab PyGithub

Iterating

  1. Make any code changes to the criticality score algorithm here.

  2. Run the criticality score code using:

python3 -m criticality_score.run --repo=<repo_url>