Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 1.7 KB

DEVELOP.md

File metadata and controls

43 lines (30 loc) · 1.7 KB
Raw

Development info for NeuroFormats.js

Recommended dev environment

I used VisualStudio Code with the Julia extension. Use whatever you like.

Adding a new function to the package API

These involves the following steps:

  • create a new branch off develop.
  • write the new function, including doc string.
  • Depending on where you create the new function:
    • If you added the new function in a new source file, you have to include() the file in NeuroFormats.jl, or in the sub modules files like FreeSurfer.jl and DTI.jl.
    • Otherwise (i.e., you created the function in an existing source file), you have to export() the function in the respective sub module file, like FreeSurfer.jl.
  • add and run unit tests for the new function.
  • git add and commit, create a PR against develop.

Running the unit tests

cd <repo>
julia
# now, in the julia interpreter, hit the ']' key. This changes the
# prompt from 'julia> ' to something like '(@v1.5) pkg> '. Then:
dev .
test NeuroFormats.jl

You can hit CTRL + d to exit once you're done.

Releasing a new version

To release a new version:

  • Make sure you have updated the CHANGES file
  • If there are new dependencies, make sure you added compat entries in Project.toml
  • Bump the package version in Project.toml
  • Git add and commit
  • On the Github repo website, go to the commit and comment '@JuliaRegistrator register'.
  • The bot will start some checks, if they succeed you are done: releasing on Juliahub and tagging the commit with the release version are done automatically. If the checks fail, fix the issues in a new commit and comment again. Just ignore the old attempt, you do not need to do anything about it.