Developer Guide

This page describes how to contribute to MyPkg41.jl.

Contributing

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

Versioning

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

• Project.toml
• CITATION.bib

Formatting

julia --project=@runic --startup-file=no -e 'using Pkg; Pkg.add(\"Runic\")'

Commands

This section lists typical commands for local development.

Clone Repository

Clone the repository. Cloning is required only once. If Revise.jl is not installed, run import Pkg; Pkg.add("Revise") in the REPL.

git clone https://github.com/ohno/MyPkg41.jl.git
cd MyPkg41.jl

Start Development

Start an interactive session with Revise.jl. If Revise.jl is not installed, run import Pkg; Pkg.add("Revise") in the REPL.

julia --startup-file=no -i -E 'using Revise; import Pkg; Pkg.activate(\".\"); using MyPkg41; MyPkg41.hello()'

Add Dependency

Use these commands to add PkgName.jl as a dependency. Pkg.add updates Project.toml. If dependencies were edited manually, run Pkg.resolve() and Pkg.instantiate().

julia --project=. --startup-file=no -e 'import Pkg; Pkg.add(\"PkgName\")'
julia --project=. --startup-file=no -e 'import Pkg; Pkg.resolve(); Pkg.instantiate()'

Run Tests

Run the local test suite. Run this before pushing commits.

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

Generate Documentation

Build the documentation locally. Run the first command once to set up the docs environment, and run the second command to rebuild the 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")'