Developer's Guide

This page describes how to contribute to MyPkg31.jl.

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

This section lists typical commands for local development.

Development using Revise.jl

git clone https://github.com/ohno/MyPkg31.jl.git
cd MyPkg31.jl
julia --startup-file=no -i -E 'using Revise; import Pkg; Pkg.activate(\".\"); using MyPkg31; MyPkg31.hello()'

Dependency Maintenance

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

Run Tests

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

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")'