metric

package
Version: v0.0.0-...-bf65384 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 28, 2018 License: MIT Imports: 4 Imported by: 0

Documentation

Overview

Package metric contains all the metrics that analyze Pull Requests in different ways.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Age

type Age struct {
	// contains filtered or unexported fields
}

Age contains the calculated data

func (*Age) Calculate

func (m *Age) Calculate(pullRequests []github.PullRequest) error

Calculate the average age of a PR in total and by developer

func (*Age) Description

func (m *Age) Description() string

Description of the metric

func (*Age) String

func (m *Age) String() string

Converts the calculated data to a string

type AgeAssignee

type AgeAssignee struct {
	// contains filtered or unexported fields
}

AgeAssignee contains the calculated data

func (*AgeAssignee) Calculate

func (m *AgeAssignee) Calculate(pullRequests []github.PullRequest) error

Calculate the average age of a PR in total and by developer

func (*AgeAssignee) Description

func (m *AgeAssignee) Description() string

Description of the metric

func (*AgeAssignee) String

func (m *AgeAssignee) String() string

Converts the calculated data to a string

type Assignee

type Assignee struct {
	// contains filtered or unexported fields
}

Assignee contains the calculated data

func (*Assignee) Calculate

func (m *Assignee) Calculate(pullRequests []github.PullRequest) error

Calculate how often each developer is an assignee

func (*Assignee) Description

func (m *Assignee) Description() string

Description of the metric

func (*Assignee) String

func (m *Assignee) String() string

Converts the calculated data to a string

type AssigneeMatrix

type AssigneeMatrix struct {
	// contains filtered or unexported fields
}

AssigneeMatrix contains the calculated data

func (*AssigneeMatrix) Calculate

func (m *AssigneeMatrix) Calculate(pullRequests []github.PullRequest) error

Calculate how often each developer is an assignee

func (*AssigneeMatrix) Description

func (m *AssigneeMatrix) Description() string

Description of the metric

func (*AssigneeMatrix) String

func (m *AssigneeMatrix) String() string

Converts the calculated data to a string

type Author

type Author struct {
	// contains filtered or unexported fields
}

Author contains the calculated data

func (*Author) Calculate

func (m *Author) Calculate(pullRequests []github.PullRequest) error

Calculate how often each developer is an author

func (*Author) Description

func (m *Author) Description() string

Description of the metric

func (*Author) String

func (m *Author) String() string

Converts the calculated data to a string

type AuthorComments

type AuthorComments struct {
	// contains filtered or unexported fields
}

AuthorComments contains the calculated data

func (*AuthorComments) Calculate

func (m *AuthorComments) Calculate(pullRequests []github.PullRequest) error

Calculate the data

func (*AuthorComments) Description

func (m *AuthorComments) Description() string

Description of the metric

func (*AuthorComments) String

func (m *AuthorComments) String() string

Converts the calculated data to a string

type CommentCharsPerDay

type CommentCharsPerDay struct {
	// contains filtered or unexported fields
}

CommentCharsPerDay contains the calculated data

func (*CommentCharsPerDay) Calculate

func (m *CommentCharsPerDay) Calculate(pullRequests []github.PullRequest) error

Calculate the average age of a PR in total and by developer

func (*CommentCharsPerDay) Description

func (m *CommentCharsPerDay) Description() string

Description of the metric

func (*CommentCharsPerDay) String

func (m *CommentCharsPerDay) String() string

Converts the calculated data to a string

type DescriptionSize

type DescriptionSize struct {
	// contains filtered or unexported fields
}

DescriptionSize contains the calculated data

func (*DescriptionSize) Calculate

func (m *DescriptionSize) Calculate(pullRequests []github.PullRequest) error

Calculate the data

func (*DescriptionSize) Description

func (m *DescriptionSize) Description() string

Description of the metric

func (*DescriptionSize) String

func (m *DescriptionSize) String() string

Converts the calculated data to a string

type DiffSize

type DiffSize struct {
	// contains filtered or unexported fields
}

DiffSize contains the calculated data

func (*DiffSize) Calculate

func (m *DiffSize) Calculate(pullRequests []github.PullRequest) error

Calculate the average age of a PR in total and by developer

func (*DiffSize) Description

func (m *DiffSize) Description() string

Description of the metric

func (*DiffSize) String

func (m *DiffSize) String() string

Converts the calculated data to a string

type DiffSizePerDay

type DiffSizePerDay struct {
	// contains filtered or unexported fields
}

DiffSizePerDay contains the calculated data

func (*DiffSizePerDay) Calculate

func (m *DiffSizePerDay) Calculate(pullRequests []github.PullRequest) error

Calculate the average age of a PR in total and by developer

func (*DiffSizePerDay) Description

func (m *DiffSizePerDay) Description() string

Description of the metric

func (*DiffSizePerDay) String

func (m *DiffSizePerDay) String() string

Converts the calculated data to a string

type Metric

type Metric interface {
	Description() string
	Calculate(pullRequests []github.PullRequest) error
	String() string
}

Metric is a common interface for every metric in metric/*.go

func Metrics

func Metrics() []Metric

Metrics returns the list of all available metrics

type ReviewRequest

type ReviewRequest struct {
	// contains filtered or unexported fields
}

ReviewRequest contains the calculated data

func (*ReviewRequest) Calculate

func (m *ReviewRequest) Calculate(pullRequests []github.PullRequest) error

Calculate the data

func (*ReviewRequest) Description

func (m *ReviewRequest) Description() string

Description of the metric

func (*ReviewRequest) String

func (m *ReviewRequest) String() string

Converts the calculated data to a string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL