.. _ydoc-contributing-guide:

Contributing
============

.. include:: /_snippets/ai-warning.rst

Hello new **Contributor**!
Thank you for taking the initiative to contribute, we are happy to have you to help out!
Anyone is allowed to contribute to the community docs *(And trust me, we need it)*.
Here are some ways to help:

 * Completing documentation :ref:`coverage <yverb-coverage>` for our :ref:`class reference documentation <ydoc-class-reference>`
 * Help writing :ref:`Tutorials <ydoc-tutorial-start>`
 * Expanding/Filling in unfinished/placeholder :ref:`articles <yverb-article>`.
 * Expanding this `Documentation <https://github.com/Errorbot1122/yomi-docs/>`_
 * Improving our `Backend <https://github.com/Errorbot1122/yomi-docs/blob/main/_tools/>`_

.. TODO: Turn this into a full section

If you feel that is to hard, you can always submit an **Issue** (``BUG``) or **Proposal** (``[FR]``) at our `Github <https://github.com/Errorbot1122/yomi-docs/issues>`_. 
*(Always check to see if one already exists, before creating a new one)*

Now if you are *up for the task*, please read our :ref:`AI Policy <ydoc-contributing-ai>`, then your specific :ref:`Contributing Guidelines <ydoc-contributing-guidelines>` before contributing.

.. tip:: To autoload your changes to your local computer, run ``bash ./run.sh`` in your terminal.
         
         *(Make sure* `git-bash <https://www.geeksforgeeks.org/git/working-on-git-bash/>`_ *is installed on your computer, if you use Windows)*

Guidelines
----------

Read the bellow guides to learn about how you should contribute correctly.

.. toctree::
   :maxdepth: 1
   
   docs
   classes

.. code <- TODO: Add this when written


.. _ydoc-contributing-ai:

.. XXX: EARLY DRAFT

Our Stance on AI
----------------

.. Bro I just wanna release this, I'm tired...
.. note:: This is currently an **early draft**, so our opinions *may change*!
          
          Please check this periodically to be informed on if things have been *modified*.

*AI* can and is a vary useful tool *(especially when programming)* - and due to the nature of this project, it be tempting to use...
**However**, we do not codon the use of ANY **Text**, **Image**, **Video**, **Audio generation AI** in any **Documentation** written for this project.
(essentially any ``.rst`` files).

.. FIXME: This reasoning is SHIT... BUT I CANT THINK OF ANYTHING :sob:

This is because, the *YOMI Modding* community is not vary big, and we want to allow actual **community members** to have to opportunity to both teach and learn from each other.

*However,* there are some exceptions to this:

 * The use for translation in communication is allowed

AI Code Generation
^^^^^^^^^^^^^^^^^^

A big exceptions to this rule, is **Code generation**. A maximum of **33% of contributed code** may be submitted at a time.

This is allowed because, as stated before, **AI Generated code** can be vary useful to speed up the development process, however, it should only be used as a **tool**, not the creator.
This is because AI Generated code can quickly become impossible to maintain, and we want our community members to maybe learn something new by contributing to the codebase.

Consequences
^^^^^^^^^^^^

Braking these rules may result in being *ignored*, being **blocked** from contributing to this repo, and possibly, **moderation action** taken on external :ref:`Community Channels <ydoc-community-channels>`.

.. _ydoc-contributing-guidelines: