Calculates velocity of a sprint
If available in Hex, the package can be installed
by adding velocity
to your list of dependencies in mix.exs
:
def deps do
[
{:velocity, "~> 0.1.0"}
]
end
Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/velocity.
config :velocity, :github_api_key, "<my_github_api_key>"
Make sure the api key has enough permissions to look at repo data
owner = "revelrylabs"
repo = "velocity"
milestone_number = 1
{:ok, start_time, _} = DateTime.from_iso8601("2018-03-19T00:00:00Z")
sprint_length_in_days = 6 # optional. defaults to 6
{:ok, data} = Velocity.calculate_sprint_velocity(owner, repo, milestone_number, start_time, sprint_length_in_days)