Skip to content

Commit

Permalink
Start filling out community and contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
pushfoo committed Oct 27, 2024
1 parent 442e641 commit 27eeb8b
Show file tree
Hide file tree
Showing 2 changed files with 113 additions and 37 deletions.
43 changes: 32 additions & 11 deletions doc/community/community_locations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,38 @@
Community Locations
===================

Most of the community interaction happens on the `Arcade Discord`_ and `Arcade Github`_.
The discord server is the best place to ask questions and get help.
We have help channels, various topic channels, and a place to share
your projects. This is also where most of the development discussion
happens.
Community Standards
-------------------

Less active places (as of Summer 2024):
.. raw:: html

* `Reddit`_
* `Twitter`_
<blockquote><i>"Be excellent to each other"</i></blockquote>

Note that these communities have people of all ages from all around the
world. Please be respectful and kind to everyone. Assume good intentions
and be patient with people who are learning.
The Arcade community welcomes everyone from beginners to OpenGL experts.

You should strive to uphold the following goals regardless of a
user's age or skill level:

* Be kind by assuming good intentions
* Be patient, especially with beginners
* Be respectful of others

Where to Post
-------------

Most community activity is in one of two places:

* The `Arcade Discord`_ server is the most active spot
* The `Arcade Github`_ repository hosts code and issues

If you're unsure, the Discord is the best place to ask questions.
This includes changes such as new features, or just :ref:`getting help <how-to-get-help>`.

Other Locations
---------------

Arcade has a presence on the platforms below, but they're not very active as
of Summer 2024:

* `r/pythonarcadde <Reddit>`_ on Reddit
* `@ArcadeLibrary <Twitter>`_ on x.com (formerly Twitter)
107 changes: 81 additions & 26 deletions doc/contributing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,47 +3,102 @@
Contributing To Arcade
======================

We would love to have you contribute to the project! There are several
ways that you can do so.
We would love to have you contribute to the project!

Arcade's powerful features and documentation couldn't
exist without help and contributions from users like you.

Contributing Code
-----------------

If you are interested in contributing code, please check out the `Github Contributing Guide`_

.. _Github Issue List: https://github.com/pythonarcade/arcade/issues
.. _Github Contributing Guide: https://github.com/pythonarcade/arcade/blob/development/CONTRIBUTING.md

I Can't Code Yet
----------------
Even as a complete beginner, there are several ways you can help.

Tell Us About Documentation Issues
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Let us know if anything's off or hard to follow about this
documentation.

It doesn't matter whether you've started :ref:`the platformer tutorial <platformer_tutorial>`
or just happen to be looking around. Let us know if anything looks off.

The best ways to report it are via `Discord <Arcade Discord>`_
or `GitHub <Arcade GitHub>`_, but we also have other
:ref:`community-locations`.

To be clear, all of the following are worth reporting:

* Accessibility issues such as poor contrast or readability
* Mistakes in spelling or grammar mistakes
* Poorly written or hard to read material
* Incorrect or outdated information
* Odd behavior in styles or UI
* Broken links

Play Games made with Arcade
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Arcade users often participate in game jams. Helping them
is as easy as:

#. Playing their games
#. Providing feedback via the game jam's comments

That includes reporting bugs on their projects to help them improve.

Create Art, Music, and Sound
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If you're an artist or a musician, you can build your skills
through game jams or game asset communities.

* `The Python Discord`_ hosts team formation and more for the `PyWeek`_ game jam
* `OpenGameArt.org <https://opengameart.org/>`_ is a long-running game asset community
* Various pixel art communities exist on Discord and Reddit

.. _contributing-bug-reports:
Report Bugs
-----------

If you see something weird, let the devs know!

Whether it's via `GitHub <GitHub Issue List>`_ or the `Arcade Discord`_,
even a simple screenshot or video capture can help us make Arcade better.
This includes:

* Crashes on launch or any other time
* Odd behavior in Arcade's examples
* Functions not working correctly

Detailed Bug Reports
--------------------
These are great when they have clear replication steps.

Whether it's on `GitHub <GitHub Issue List>` or the `Arcade Discord`_, the
idea's the same:
Excellent Bug Reports
^^^^^^^^^^^^^^^^^^^^^
The best bug reports are specific and repeatable.

The following steps helps us fix bugs faster by making it easier to find
the source of the problem.

#. Note your :ref:`Python and Arcade versions <help-basic-environment-info>`
#. Try to figure out when and how to make the bug happen

* This can be hard, and that's okay
* If you can't put it into words, any of the follwoing can help!
* Remember: this can be hard, and that's okay
* If you can't put it into words, any of the following can help!

* Screenshots or recordings
* Screenshots or video recordings
* Error traceback
* Example code that makes the problem happen

#. Search the `GitHub Issue List`_ for anything similar

* If it exists, comment
* If not, post a new one
* Don't worry too much about posting duplicates

How to contribute without coding
--------------------------------

* **Community** - Post your projects, code, screen-shots, and discuss the Arcade library on the `Python Arcade SubReddit`_.
* Try coding your own animations and games. Write down notes on anything that
is difficult to implement or understand about the library.
* **Suggest improvements** - Post bugs and enhancement requests at the `Github Issue List`_.
Don't worry too much about posting duplicates. We can always cross-reference
issues if it's a duplicate. If you're unsure, you can always ask on `Discord <Arcade Discord>`_.

How to contribute code
----------------------

If you are interested in contributing code, please check out the `Github Contributing Guide`_

.. _Python Arcade SubReddit: https://www.reddit.com/r/pythonarcade
.. _Github Issue List: https://github.com/pythonarcade/arcade/issues
.. _Github Contributing Guide: https://github.com/pythonarcade/arcade/blob/development/CONTRIBUTING.md

0 comments on commit 27eeb8b

Please sign in to comment.