Skip to content
This repository has been archived by the owner on Jun 14, 2023. It is now read-only.

Latest commit

 

History

History
43 lines (30 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

43 lines (30 loc) · 1.1 KB

Contributing to HMMBase

Contributions to HMMBase are welcome!
Please try to submit short pull requests with a well-defined scope.

Development

  1. To make changes, start by forking the repository.
  2. Then, clone the package for development:
pkg> dev git@github.com:USERNAME/HMMBase.jl.git

  1. From now on, using HMMBase will use your fork.
    (To re-install the main version, use pkg> add HMMBase in the Julia REPL.)

  2. Make changes as desired, and ensure that the tests are passing:

pkg> test HMMBase
  1. Format the code using JuliaFormatter:
julia> using JuliaFormatter
julia> format(".")
  1. Commit your changes and submit the PR!

Benchmarks and documentation

Compiler calls: JULIA_DEBUG=loading

julia --project=benchmark/ benchmark/make.jl
julia --project=docs/ docs/literate.jl
julia --project=docs/ docs/make.jl

Internals

See Internals in the documentation.