Closed ArnoStrouwen closed 2 years ago
I'm not sure why the contributing.md page is being removed as it is a good place to provide guidelines to new contributors.
At present it contains important information related to how to format code before making pull requests.
using JuliaFormatter, Surrogates
format(joinpath(dirname(pathof(Surrogates)), ".."))
In addition, I was planning on adding the following contributor guidelines to contributing.md:
###########
Contributor Guidelines:
###########
One alternative is to retain the contributing.md and indicate how the contents of ColPrac relates to the CONTRIBUTING.md as prescribed in the last section of the ColPrac/README.md.
Most of those items sound like they should go to a general SciML contributions page and not be repeated for every package?
Most of those items sound like they should go to a general SciML contributions page and not be repeated for every package?
Yes. This applies to the docstrings and documenting rationale for making certain programming choices (items 3 and 5 from the list above).
However, I believe that the other items may be unique to surrogates (i.e. ensure that tests establish baseline accuracy, provide references to papers while writing code and add surrogates with unique package dependencies to the libs folder.)
Codecov Report
97.14% <0.00%> (-2.86%)
71.61% <0.00%> (-0.45%)
88.07% <0.00%> (-0.22%)
94.97% <0.00%> (-0.07%)
97.22% <0.00%> (-0.03%)
:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more