Skip to content

Latest commit

 

History

History
28 lines (23 loc) · 1.63 KB

DevelopGuide.md

File metadata and controls

28 lines (23 loc) · 1.63 KB
Raw

Package development

How to CODE

In general, we prefer using Juno. Jupyter notebooks with IJulia kernel is suited for writting simple code, but it is well known as hard to be version controlled.

Coding in vim directly is not recommended since running code line by line is nessesary for debuging Julia programs (There is no jdb!).

How to develop a Project

Start a new project

https://docs.julialang.org/en/v1/stdlib/Pkg/index.html#Creating-your-own-projects-1

comments
  • activate . sould be used when you are going to change the dependancy of a project in current folder (i.e. changing ./Project.toml).
  • uuid contains the information of both package name and version number.

setup continuous integration

To run a test, type julia test/runtests.jl. To setup continuous integration for your tests and documents, you need

  1. get started with Travis-ci,
  2. configure .travis.yml
  3. setup julia build,
  4. add building status badge
  5. setup CodeCov to ensure test coverage,
  6. use Documenter to deploy documents.
  7. it is interesting to see how other projects (e.g. FunnyTN) works.

Register your package

See METADATA for detail.