Skip to content

Commit ccbf8b7

Browse files
committed
Add mention of pre-commit to CONTRIBUTING
1 parent 4e56b8a commit ccbf8b7

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,7 @@ _Only the two maintainers are allowed to approve and merge pull requests._
99
Feel free to ping them if they do not answer within a week or so.
1010

1111
Apart from the conditions above, this repository follows the [ColPrac](https://github.com/SciML/ColPrac) best practices and [Conventional Commits](https://www.conventionalcommits.org/en/).
12-
Its code is formatted using [JuliaFormatter.jl](https://github.com/domluna/JuliaFormatter.jl) with [BlueStyle](https://github.com/JuliaDiff/BlueStyle) -- please format any modified code before opening a pull request, otherwise CI will fail.
12+
Its code is formatted using [JuliaFormatter.jl](https://github.com/domluna/JuliaFormatter.jl) with [BlueStyle](https://github.com/JuliaDiff/BlueStyle).
13+
As part of continuous integration, a set of formal tests is run using [pre-commit](https://pre-commit.com/).
14+
We invite you to install pre-commit so that these checks are performed locally before you open or update a pull request.
1315
You can refer to the [dev guide](https://juliadiff.org/DifferentiationInterface.jl/DifferentiationInterface/dev/dev_guide/) for details on the package structure and the testing pipeline.

DifferentiationInterface/src/DifferentiationInterface.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ include("first_order/derivative.jl")
5858
include("first_order/gradient.jl")
5959
include("first_order/jacobian.jl")
6060

61-
include( "second_order/second_derivative.jl")
61+
include("second_order/second_derivative.jl")
6262
include("second_order/hvp.jl")
6363
include("second_order/hessian.jl")
6464

0 commit comments

Comments
 (0)