2022-04-19 20:12:40 +02:00
|
|
|
# Contributing
|
|
|
|
|
|
|
|
|
|
When contributing to this repository, please first discuss the change you wish to make via issue,
|
|
|
|
|
email, or any other method with the owners of this repository before making a change.
|
|
|
|
|
|
|
|
|
|
Please note we have a code of conduct, please follow it in all your interactions with the project.
|
|
|
|
|
|
2022-04-28 17:02:40 +02:00
|
|
|
# Julia Development Environment
|
|
|
|
|
|
2022-04-30 12:37:22 +02:00
|
|
|
Link your local git repository to Julia:
|
|
|
|
|
```console
|
2022-04-28 17:02:40 +02:00
|
|
|
$ ln -s ~/path/to/TrainRun.jl ~/.julia/dev/TrainRun
|
|
|
|
|
```
|
|
|
|
|
|
2022-04-30 12:37:22 +02:00
|
|
|
Have a look here how to develop Julia packages: https://github.com/ShozenD/julia-pkg-dev
|
|
|
|
|
You might want to use `Revise.jl` as well:
|
|
|
|
|
```julia
|
|
|
|
|
Pkg.add("Revise")
|
|
|
|
|
```
|
|
|
|
|
and then just load with `using Revise` (preferably by putting it in the `~/.julia/config/startup.jl` file)
|
|
|
|
|
|
|
|
|
|
```julia
|
|
|
|
|
(@v1.x) pkg> develop TrainRun
|
|
|
|
|
(@v1.x) pkg> activate TrainRun
|
|
|
|
|
(TrainRun) pkg>
|
|
|
|
|
```
|
2022-04-28 17:02:40 +02:00
|
|
|
|
|
|
|
|
|
2022-04-19 20:12:40 +02:00
|
|
|
# Pull Request Process
|
|
|
|
|
|
|
|
|
|
* add your changes to the CHANGELOG.md under [Unreleased]
|
|
|
|
|
* TODO!
|
