search

JuliaOptimalTransport / OptimalTransport.jl

Optimal transport algorithms for Julia
https://juliaoptimaltransport.github.io/OptimalTransport.jl/dev
MIT License
93 stars 8 forks source link

Contribution Workflow #148

Closed davibarreira closed 2 years ago

davibarreira commented 2 years ago

Hey guys, it's been a while. Thankfully I'm done with my phd qualification, and I'm starting to work again on some Optimal Transport stuff. I just submitted a small PR, and I realized I forgot some of the workflow for contributing (like, the command to adjust the style and documentation building). I was thinking that perhaps it would be nice to have a small section in the readme (or the docs) with "workflow" to contribute. Like, "remember to run this, and run that etc". What do you think?

devmotion commented 2 years ago

I guess some instructions similar to https://github.com/JuliaGaussianProcesses/KernelFunctions.jl/tree/master/examples could/should be added to the examples folder. Maybe also for the docs (similar to https://github.com/JuliaGaussianProcesses/KernelFunctions.jl/tree/master/docs), but there the setup is very standard (apart from the examples), so one can mainly refer to the documentation of Documenter? More general recommendations could be added e.g. to a pull request template that is shown to everyone who opens a PR (e.g., in KernelFunctions the following is used: https://github.com/JuliaGaussianProcesses/KernelFunctions.jl/blob/master/.github/PULL_REQUEST_TEMPLATE.md)