Skip to content

Move Contributing doc out of Programming Guide #1774

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.

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
37 changes: 37 additions & 0 deletions doc/contributing_guide/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
.. _cg_index:

Arcade Contributing Guide
=========================

The contributing guide is for people who want to propose changes,
implement features, or report bugs in Arcade itself.

For information on how to use arcade to build your own projects, please see
:ref:`pg_index`.


.. _cg_index_quickstart:

Contributing Quickstart
^^^^^^^^^^^^^^^^^^^^^^^
For a quick overview, please see
`CONTRIBUTING.md on GitHub <https://github.com/pythonarcade/arcade/blob/development/CONTRIBUTING.md>`_.


.. _cg_index_contents:

Contributing Guide Contents
^^^^^^^^^^^^^^^^^^^^^^^^^^^

The sections linked below will provide more in-depth coverage of various topics
contributing to arcade, including links to outside resources on development tools
and practices.

.. toctree::
:maxdepth: 1

directory_structure
how_to_contribute
how_to_build
how_to_submit_changes
release_checklist
13 changes: 7 additions & 6 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,13 +77,8 @@ The Python Arcade Library
programming_guide/get_started
programming_guide/sprites/index
programming_guide/how_to_get_help
programming_guide/directory_structure
programming_guide/edge_artifacts/index
programming_guide/how_to_submit_changes
programming_guide/how_to_contribute
programming_guide/how_to_build
programming_guide/logging
programming_guide/release_checklist
programming_guide/pygame_comparison
programming_guide/headless
programming_guide/vsync
Expand Down Expand Up @@ -113,11 +108,17 @@ The Python Arcade Library

.. toctree::
:maxdepth: 1
:caption: Source Code
:caption: Source Code & Contributing

GitHub <https://github.com/pythonarcade/arcade>
programming_guide/release_notes
License <https://github.com/pythonarcade/arcade/blob/development/license.rst>
contributing_guide/index
contributing_guide/directory_structure
contributing_guide/how_to_contribute
contributing_guide/how_to_build
contributing_guide/how_to_submit_changes
contributing_guide/release_checklist

.. image:: images/social.svg
:alt: Social icon
Expand Down
5 changes: 0 additions & 5 deletions doc/programming_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,8 @@ external documentation where applicable.
get_started
sprites/index
how_to_get_help
directory_structure
edge_artifacts/index
how_to_submit_changes
how_to_contribute
how_to_build
logging
release_checklist
pygame_comparison
headless
vsync
Expand Down