Skip to content

Improve contribution docs #15872

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 4, 2022
Merged

Improve contribution docs #15872

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a76d60d
Minor documentation improvements for contributors
mmarczell-graphisoft Jan 3, 2022
a7fcf1a
fix my name to international order
mmarczell-graphisoft Jan 3, 2022
884298d
This does not need the popout formatting any more
mmarczell-graphisoft Jan 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AUTHORS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -586,3 +586,4 @@ a license to everyone to use it as detailed in LICENSE.)
* Nathan Rugg <[email protected]> (copyright owned by Chess.com, LLC)
* Alexander O'Mara <[email protected]>
* Kamaron Peterson <[email protected]>
* Márton Marczell <[email protected]> (copyright owned by GRAPHISOFT SE)
3 changes: 1 addition & 2 deletions site/source/docs/contributing/AUTHORS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ AUTHORS
=======

The `AUTHORS <https://github.com/emscripten-core/emscripten/blob/main/AUTHORS>`_ file lists everyone who has contributed to Emscripten.

.. 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.
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>`.

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

Expand Down
4 changes: 3 additions & 1 deletion site/source/docs/contributing/developers_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ binaries with a checkout of the core Emscripten repository, simply by calling
``emcc.py`` from that checkout, and it will use the binaries from the emsdk.

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

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