Skip to content

Commit 3b6f294

Browse files
[Docs] Improve contribution docs (#15872)
Adds notes discussed in #14354 and #15592 , specifically about AUTHORS being optional, and linking to the code style docs.
1 parent 48e3d9d commit 3b6f294

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

AUTHORS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -586,3 +586,4 @@ a license to everyone to use it as detailed in LICENSE.)
586586
* Nathan Rugg <[email protected]> (copyright owned by Chess.com, LLC)
587587
* Alexander O'Mara <[email protected]>
588588
* Kamaron Peterson <[email protected]>
589+
* Márton Marczell <[email protected]> (copyright owned by GRAPHISOFT SE)

site/source/docs/contributing/AUTHORS.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ AUTHORS
55
=======
66

77
The `AUTHORS <https://github.com/emscripten-core/emscripten/blob/main/AUTHORS>`_ file lists everyone who has contributed to Emscripten.
8-
9-
.. note :: Authors must add themselves to the `AUTHORS <https://github.com/emscripten-core/emscripten/blob/main/AUTHORS>`_ file before :doc:`contributing <contributing>`. This act licenses their changes under the project’s :ref:`open source licenses (MIT/LLVM) <emscripten-license>`. Note that the developer retains copyright.
8+
It is optional for a contributor to add themselves to the `AUTHORS <https://github.com/emscripten-core/emscripten/blob/main/AUTHORS>`_ file before :doc:`contributing <contributing>`.
109

1110
The contributors for releases up to Emscripten |release| inclusive (|today|) are listed below.
1211

site/source/docs/contributing/developers_guide.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ binaries with a checkout of the core Emscripten repository, simply by calling
3030
``emcc.py`` from that checkout, and it will use the binaries from the emsdk.
3131

3232
If you do want to contribute to LLVM or Binaryen, or to test modifications
33-
to them, you can
33+
to them, you can
3434
:ref:`build them from source <installing-from-source>`.
3535

3636
Repositories and branches of interest
@@ -55,6 +55,8 @@ When submitting patches, please:
5555
in ``tests/*.py`` for related tests, as often the simplest thing is to add to
5656
an existing one. If you're not sure how to test your code, feel free to ask
5757
for help.
58+
- Pay attention to our coding style specified in
59+
`.clang-format <https://github.com/emscripten-core/emscripten/blob/main/.clang-format>`_.
5860
- We normally squash and merge PRs, which means the PR turns into a single
5961
commit on the target branch. Because of that, it's ok to have merge commits
6062
in the PR itself, as they get removed. Please put a good description for

0 commit comments

Comments
 (0)