Skip to content

Commit

Permalink
Link from docs/process.md to "contributing" section of the webside (#…
Browse files Browse the repository at this point in the history
…20885)

I guess we should consolidate these somehow.

Also format long lines in `contributing.rst`
  • Loading branch information
sbc100 authored Dec 9, 2023
1 parent dedd59b commit f9871ec
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 11 deletions.
3 changes: 3 additions & 0 deletions docs/process.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Development Processes

More information can be found in the [Contribution
section](https://emscripten.org/docs/contributing/contributing.html) of the
webside.

## Landing PRs

Expand Down
28 changes: 18 additions & 10 deletions site/source/docs/contributing/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,35 @@
Contributing
============

Anyone can contribute to Emscripten — if you find it useful and want to help improve the project, follow the suggestions below.
Anyone can contribute to Emscripten — if you find it useful and want to help
improve the project, follow the suggestions below.

Feel free to file :ref:`bug reports <bug-reports>`, :ref:`join the discussion <contact>` and share your own ideas with the community!
Feel free to file :ref:`bug reports <bug-reports>`, :ref:`join the discussion
<contact>` and share your own ideas with the community!


Getting started
===============

A good starting point is to work on the `open issues on GitHub <https://github.com/emscripten-core/emscripten/issues?state=open>`_. Many issues can be resolved without an in-depth knowledge of compiler internals, and this is a great way to learn more about the project.
A good starting point is to work on the `open issues on GitHub
<https://github.com/emscripten-core/emscripten/issues?state=open>`_. Many issues
can be resolved without an in-depth knowledge of compiler internals, and this is
a great way to learn more about the project.

.. tip:: We really appreciate your help. Every existing issue closed means more time for the core contributors to work on new features, optimizations and other enhancements.
.. tip:: We really appreciate your help. Every existing issue closed means more
time for the core contributors to work on new features, optimizations and
other enhancements.

In addition to improving the toolchain, you can also :ref:`review and update this documentation <about-this-site-contributing>`.
In addition to improving the toolchain, you can also :ref:`review and update
this documentation <about-this-site-contributing>`.


Next steps
==========

As a new contributor you should read the :ref:`Developer's-Guide`. You may also need to :ref:`install Emscripten from source <installing-from-source>` and become familiar with :ref:`Debugging` and :ref:`Building-Projects`.

Please :ref:`get in touch with the community <contact>` to share your ideas and work out where you can make the most difference.


As a new contributor you should read the :ref:`Developer's-Guide`. You may also
need to :ref:`install Emscripten from source <installing-from-source>` and
become familiar with :ref:`Debugging` and :ref:`Building-Projects`.

Please :ref:`get in touch with the community <contact>` to share your ideas and
work out where you can make the most difference.
3 changes: 2 additions & 1 deletion site/source/docs/contributing/developers_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ This article provides information that is relevant to people who want to
contribute to Emscripten. We welcome contributions from anyone that is
interested in helping out!

.. tip:: The information will be less relevant if you're just using Emscripten, but may still be of interest.
.. tip:: The information will be less relevant if you're just using Emscripten,
but may still be of interest.

.. _developers-guide-setting-up:

Expand Down

0 comments on commit f9871ec

Please sign in to comment.