chore: update CONTRIBUTING.md #12440
Conversation
shonfeder
commented
Sep 9, 2025
shonfeder
commented
- Codify a lightweight development and design process, based on conversations with many active core developers in various meetings.
- Inviting feedback on issues as a way to contribute. This may seem obvious, but it bears making this explicit.
- Break subjects into clear subsections to improve Scannability.
- Point new contributors to our "good first issues".
- Link both the rendered and the source for the hacking doc.
- Tweak some phrasing
shonfeder
requested review from
Alizter,
Leonidas-from-XIV,
anmonteiro,
gridbugs,
nojb and
rgrinberg
|
I tagged in quite a few folks for review, just to be sure that interested parties can review if they care to. But please don't feel obligated to review/approve if you don't. The important thing is just that blocking concerns be addressed, if there turns out to be any. |
| Developer documentation | ||
| ----------------------- | ||
|
|
||
| See our developer documentation at [./doc/hacking.rst][hack] or |
There was a problem hiding this comment.
A pointer could also be added to point to the "Tour of the Dune Codebase". When I started working on Dune, it was also a good place to learn more about the internal behavior.
There was a problem hiding this comment.
Oh that is handy! Thanks for pointing this out. However, I will suggest that we instead link this at the top of hacking.rst, so we have one entry point for developer documentation. Are you okay with this alternative?
shonfeder
force-pushed
the
shon/update-contributing-docs
branch
from
c641ae6 to
6b45032
Compare
shonfeder
force-pushed
the
shon/update-contributing-docs
branch
from
6b45032 to
7b29cca
Compare
|
By the way, when you tag somebody in a commit, it will notify them each time you push. So please edit the description to not include the |
shonfeder
force-pushed
the
shon/update-contributing-docs
branch
from
7b29cca to
b8534fd
Compare
|
Thanks for the reviews! I'd appreciate another review here so I can land this little documentation change. It sounds like there are no objections to the core points proposed. |
shonfeder
force-pushed
the
shon/update-contributing-docs
branch
from
01f81ba to
9ef1dc2
Compare
| developed at [Jane Street][js] and is now maintained by Jane Street, | ||
| [Tarides][tarides] as well as several developers from the OCaml | ||
| community. | ||
| Dune is an community orientated open source project. It was originally developed |
There was a problem hiding this comment.
| Dune is an community orientated open source project. It was originally developed | |
| Dune is a community orientated open source project. It was originally developed |
Sudha247
left a comment
Sudha247
left a comment
There was a problem hiding this comment.
Thanks for expanding the contributing section!
| proportional to the scope and impact of the intended change. | ||
| - This design should be reviewed by at least one other party. | ||
| - Github issues are an appropriate venue for most design discussions, but more | ||
| involved design work may warrant an RFC or ADR. |
There was a problem hiding this comment.
What is an ADR? Google says "Alternative Dispute Resolution" but I don't see how this applies here.
There was a problem hiding this comment.
I guess you may need to specify the context of software tog et the right result :) https://adr.github.io/
| the below (from [developercertificate.org][dco]): | ||
| Dune is distributed under the MIT license and contributors are required to sign | ||
| their work in order to certify that they have the right to submit it under this | ||
| license. |
There was a problem hiding this comment.
maybe something like
Signed-off-by: Example Person <[email protected]>
at the end of your commit should be mentioned. There are two types of commit signing in Git which are sometimes confused. The other is GPG signing which we don't care about and can be a bit involved to set up, so we should be clearer to potential contributors about this.
There was a problem hiding this comment.
I see that we do mention this after the certificate. Perhaps we should pull that example above.
There was a problem hiding this comment.
I haven't changed the copy here at all, but I'm fine with moving this above as part this PR.
Alizter
left a comment
Alizter
left a comment
There was a problem hiding this comment.
My comments aren't blocking. The rest looks good to me.
- Codify a lightweight development and design process, based on conversations with many active core developers in various meetings. - Inviting feedback on issues as a way to contribute. This may seem obvious, but it bears making this explicit. - Break subjects into clear subsections to improve Scannability. - Point new contributors to our "good first issues". - Link both the rendered and the source for the hacking doc. - Tweak some phrasing Signed-off-by: Shon Feder <[email protected]>
Signed-off-by: Shon Feder <[email protected]>
Signed-off-by: Shon Feder <[email protected]>
Signed-off-by: Shon Feder <[email protected]>
Co-authored-by: Sudha Parimala <[email protected]> Signed-off-by: Shon Feder <[email protected]>
maiste
force-pushed
the
shon/update-contributing-docs
branch
from
5ee7310 to
826b93e
Compare
|
Let's make additional improvements in followup. Thanks for the reviews, all! |
