Developer's Guide

Contributing

The ColPrac guidelines is recommended. Please open an issue before starting significant work.

Versioning

This project follows Semantic Versioning. When bumping the version, update the version number in:

• Project.toml
• CITATION.bib

Developing

Commands

git clone https://github.com/ohno/MyPkg29.jl.git
cd MyPkg29.jl
julia -i -E 'using Revise; import Pkg; Pkg.activate("."); using PkgStarter; PkgStarter.hello()'

Run Tests:

julia --project=. --startup-file=no -e 'using Pkg; Pkg.test()'

Dependency Maintenance:

julia --project=. -e 'import Pkg; Pkg.update()'
julia --project=. -e 'import Pkg; Pkg.resolve()'
julia --project=. -e 'import Pkg; Pkg.instantiate()'

Development REPL (with Revise):

julia -i -E 'using Revise; import Pkg; Pkg.activate("."); using PkgStarter; PkgStarter.hello()'

Generate Documentation:

julia --project=docs --startup-file=no -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate();'
julia --project=docs --startup-file=no -e 'include("docs/make.jl")'