Skip to content

Commit 2f8c905

Browse files
committed
chore: update CONTRIBUTING.md
- 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]>
1 parent 2e0a649 commit 2f8c905

File tree

1 file changed

+60
-21
lines changed

1 file changed

+60
-21
lines changed

CONTRIBUTING.md

Lines changed: 60 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,69 @@
1-
Dune is an community orientated open source project. It was originally
2-
developed at [Jane Street][js] and is now maintained by Jane Street,
3-
[Tarides][tarides] as well as several developers from the OCaml
4-
community.
1+
Dune is an community orientated open source project. It was originally developed
2+
at [Jane Street][js] and is now maintained by Jane Street and [Tarides][tarides]
3+
together with several developers from the OCaml community.
54

6-
Contributions to Dune are welcome and should be submitted via GitHub
7-
pull requests against the `main` branch. See [./doc/hacking.rst][hack]
8-
for a guide to getting started on the code base.
5+
Filing issues
6+
=============
97

10-
Dune is distributed under the MIT license and contributors are
11-
required to sign their work in order to certify that they have the
12-
right to submit it under this license. See the following section for
13-
more details.
8+
The easiest way to contribute is to share your input on [issues][issues].
9+
Feedback on bug reports, feature requests, and documentation is welcome and
10+
appreciated. If you don't find a preexisting issue discussing your topic, then
11+
please [file a new issue][file an issue].
12+
13+
[file an issue]: https://github.com/ocaml/dune/issues/new/choose
14+
[issues]: https://github.com/ocaml/dune/issues
15+
16+
Developing Dune
17+
===============
18+
19+
Contributions to the Dune code base are welcome!
20+
21+
Our development process is as follows:
22+
23+
- Non-trivial submissions should be proceeded by an issue communicating the
24+
rationale for the intended change.
25+
- Substantial changes should be preceded by upfront design and planning,
26+
proportional to the scope and impact of the intended change.
27+
- This design should be reviewed by at least one other party.
28+
- Github issues are an appropriate venue for most design discussions, but more
29+
involved design work may warrant an RFC or ADR.
30+
- Design decisions agreed upon in dev meeting or online chats should also be
31+
documented and reviewed in issues or design docs. This encourages us to think
32+
through the problems thoroughly and ensures we leave a lasting record of the
33+
decision and their rationale.
34+
- Changes are submitted via GitHub pull requests against the `main` branch.
35+
36+
If you are looking to get started, check our [issues tagged with good first
37+
issue][good first issue].
38+
39+
[good first issue]: https://github.com/ocaml/dune/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22
40+
41+
Developer documentation
42+
-----------------------
43+
44+
See our developer documentation at [./doc/hacking.rst][hack] or
45+
[online][devdocs] for technical guidance about contributing to the code base.
46+
47+
[devdocs]: https://dune.readthedocs.io/en/stable/hacking.html
48+
49+
Developer meetings
50+
------------------
51+
52+
See our [developer wiki][developer wiki] for the latest information about our
53+
recurring developer meetings. All interested attendees are welcome.
54+
55+
[developer wiki]: https://github.com/ocaml/dune/wiki/
1456

1557
Signing contributions
1658
---------------------
1759

18-
We require that you sign your contributions. Your signature certifies
19-
that you wrote the patch or otherwise have the right to pass it on as
20-
an open-source patch. The rules are pretty simple: if you can certify
21-
the below (from [developercertificate.org][dco]):
60+
Dune is distributed under the MIT license and contributors are required to sign
61+
their work in order to certify that they have the right to submit it under this
62+
license.
63+
64+
Your signature certifies that you wrote the patch or otherwise have the right to
65+
pass it on as an open-source patch. The rules are pretty simple: if you can
66+
certify the below (from [developercertificate.org][dco]):
2267

2368
```
2469
Developer Certificate of Origin
@@ -81,9 +126,3 @@ you have the rights to submit this work under the same open source license.
81126
[js]: https://www.janestreet.com/
82127
[tarides]: https://tarides.com/
83128
[hack]: ./doc/hacking.rst
84-
85-
Coding style
86-
------------
87-
88-
- wrap lines at 80 characters,
89-
- use `[Ss]nake_case` over `[Pp]ascalCase`.

0 commit comments

Comments
 (0)