Skip to content

Commit 7ac1212

Browse files
authored
docs: revamp contributing guidelines (#601)
* Revamp contributing guidelines * Add CODEOWNERS * Add conventional commits * Line break in codeowners
1 parent 0ac9ad2 commit 7ac1212

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @gdalle

CONTRIBUTING.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# Contributing
22

3-
Thank you for wanting to contribute to [DifferentiationInterface.jl](https://github.com/gdalle/DifferentiationInterface.jl)!
4-
If you have a potential improvement in mind, please [open an issue](https://github.com/gdalle/DifferentiationInterface.jl/issues/new/choose) first to discuss it with the maintainers.
5-
Don't hesitate to ping said maintainers ([`@gdalle`](https://github.com/gdalle) and [`@adrhill`](https://github.com/adrhill)) if they don't answer within a week or so.
6-
Once your issue receives positive feedback, you're welcome to open a draft pull request.
7-
Draft pull requests have a lightened CI workflow, which only runs tests on the latest stable release of Julia (and not LTS or pre-release).
3+
Thank you for your willingness to contribute to [DifferentiationInterface.jl](https://github.com/gdalle/DifferentiationInterface.jl).
4+
The maintainers of this package are Guillaume Dalle ([@gdalle](https://github.com/gdalle)) and Adrian Hill ([@adrhill](https://github.com/adrhill)).
85

9-
The repository follows the [ColPrac](https://github.com/SciML/ColPrac) best practices, and its code is formatted using [BlueStyle](https://github.com/JuliaDiff/BlueStyle).
10-
Please refer to the [dev guide](https://gdalle.github.io/DifferentiationInterface.jl/DifferentiationInterface/stable/dev_guide/) for details on the package structure and the testing pipeline.
6+
If you have a problem to report or an improvement to suggest, please [open an issue](https://github.com/gdalle/DifferentiationInterface.jl/issues/new/choose) with a precise description (and a reproducible example whenever possible).
7+
Once your issue receives positive feedback, you can open a pull request to address it.
8+
_Only the two maintainers are allowed to approve and merge pull requests._
9+
Feel free to ping them if they do not answer within a week or so.
1110

11+
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.
13+
You can refer to the [dev guide](https://gdalle.github.io/DifferentiationInterface.jl/DifferentiationInterface/dev/dev_guide/) for details on the package structure and the testing pipeline.

0 commit comments

Comments
 (0)