evennia/docs/2.x/Contributing.html


<!DOCTYPE html>

<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

    <title>How To Contribute And Get Help &#8212; Evennia 2.x documentation</title>
    <link rel="stylesheet" href="_static/nature.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script src="_static/jquery.js"></script>
    <script src="_static/underscore.js"></script>
    <script src="_static/doctools.js"></script>
    <script src="_static/language_data.js"></script>
    <link rel="shortcut icon" href="_static/favicon.ico"/>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Contributing to Evennia Docs" href="Contributing-Docs.html" />
    <link rel="prev" title="Easy menu selection tree" href="Contribs/Contrib-Tree-Select.html" /> 
  </head><body>

     
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="Contributing-Docs.html" title="Contributing to Evennia Docs"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="Contribs/Contrib-Tree-Select.html" title="Easy menu selection tree"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">Evennia 2.x</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">How To Contribute And Get Help</a></li> 
      </ul>
    </div>  

    <div class="document">

      <div class="documentwrapper">
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="index.html">
              <img class="logo" src="_static/evennia_logo.png" alt="Logo"/>
            </a></p>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>
<h3><a href="index.html">Table of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">How To Contribute And Get Help</a><ul>
<li><a class="reference internal" href="#getting-help">Getting Help</a></li>
<li><a class="reference internal" href="#giving-help">Giving Help</a><ul>
<li><a class="reference internal" href="#help-with-documentation">Help with Documentation</a></li>
<li><a class="reference internal" href="#helping-with-code">Helping with code</a></li>
<li><a class="reference internal" href="#helping-with-donations">Helping with Donations</a></li>
</ul>
</li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="Contribs/Contrib-Tree-Select.html"
                        title="previous chapter">Easy menu selection tree</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="Contributing-Docs.html"
                        title="next chapter">Contributing to Evennia Docs</a></p>
  <div role="note" aria-label="source link">
    <!--h3>This Page</h3-->
    <ul class="this-page-menu">
      <li><a href="_sources/Contributing.md.txt"
            rel="nofollow">Show Page Source</a></li>
    </ul>
   </div><h3>Links</h3>
<ul>
  <li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
  <li><a href="https://www.evennia.com">Evennia Home</a> </li>
  <li><a href="https://github.com/evennia/evennia">Github</a> </li>
  <li><a href="http://games.evennia.com">Game Index</a> </li>
  <li>
    <a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
     <a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
      <a href="https://evennia.blogspot.com/">Blog</a>
  </li>
</ul>
<h3>Doc Versions</h3>
<ul>
  
    <li><a href="Contributing.html">2.x (main branch)</a></li>
 <ul>
    <li><a href="../1.3.0/index.html">1.3.0 (v1.3.0 branch)</a></li>
  
    <li><a href="../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
  

</ul>

        </div>
      </div>
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <section class="tex2jax_ignore mathjax_ignore" id="how-to-contribute-and-get-help">
<h1>How To Contribute And Get Help<a class="headerlink" href="#how-to-contribute-and-get-help" title="Permalink to this headline">¶</a></h1>
<section id="getting-help">
<h2>Getting Help<a class="headerlink" href="#getting-help" title="Permalink to this headline">¶</a></h2>
<p>If you cannot find what you are looking for in the documentation, here’s where to go next:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/evennia/evennia/discussions">The Discussions forums</a> are great for getting help, starting longer-form discussions, showing off your work or get some input on what you are working on. This is also the place to follow Evennia development.</p></li>
<li><p><a class="reference external" href="https://discord.com/invite/AJJpcRUhtF">The Discord server</a> has a very helpful <code class="docutils literal notranslate"><span class="pre">#getting-help</span></code> channel for both big and small Evennia problems. It allows for more direct discussion. You can also track both the evennia code changes and the discussion forum from discord.</p></li>
</ul>
</section>
<section id="giving-help">
<h2>Giving Help<a class="headerlink" href="#giving-help" title="Permalink to this headline">¶</a></h2>
<p>In general, being active and helpful in the <a class="reference external" href="https://github.com/evennia/evennia/discussions">discssion forums</a> or <a class="reference external" href="https://discord.com/invite/AJJpcRUhtF">discord chat</a> is already a big help!</p>
<p>If you want to spread the word, consider writing about Evennia on your blog or in your favorite (relevant) forum. Write a review somewhere (good or bad, we like feedback either way). Rate it on listings. Talk about it to your friends … that kind of thing.</p>
<section id="help-with-documentation">
<h3>Help with Documentation<a class="headerlink" href="#help-with-documentation" title="Permalink to this headline">¶</a></h3>
<p>Evennia is highly dependent on good-quality documentation!</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/evennia/evennia/issues">Reporting a Documentation issue</a> is the easiest way to help out. The more eyes we get on things, the better - if we don’t know about the problems, we can’t fix them! Even reporting typos is a great help.</p></li>
<li><p><a class="reference internal" href="Contributing-Docs.html"><span class="doc std std-doc">Contributing directly to the docs</span></a> is also possible; you just need a text editor. You can fix issues or even propose a new tutorial!</p></li>
</ul>
</section>
<section id="helping-with-code">
<h3>Helping with code<a class="headerlink" href="#helping-with-code" title="Permalink to this headline">¶</a></h3>
<p>Even if you don’t feel confident with tackling a bug or feature, just correcting typos, adjusting formatting or simply <em>using</em> the thing and reporting when stuff doesn’t make sense helps us a lot!</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/evennia/evennia/issues">Reporting a code issue or bug</a> is the easiest way to help out. Don’t assume we are aware of a problem - if it’s not written down in an issue, the problem will most likely be forgotten. Do this even if you plan to make a <em>Pull Request</em> and fix the issue yourself.</p></li>
<li><p><a class="reference external" href="https://github.com/evennia/evennia/issues">Make a feature request</a> if you want to see a new Evennia feature. You can also bring it up with the community first so you are sure it’s something that would be interesting to be included with Evennia core.</p></li>
<li><p><a class="reference internal" href="Coding/Version-Control.html#contributing-to-evennia"><span class="std std-doc">Make a Pull Request</span></a> (PR) to fix bugs or new features. Make sure to follow the <a class="reference internal" href="Coding/Evennia-Code-Style.html"><span class="doc std std-doc">Evennia Code-Style guide</span></a>.</p></li>
<li><p><a class="reference internal" href="Contribs/Contribs-Guidelines.html"><span class="doc std std-doc">The Guide for making an Evennia contrib</span></a> outlines how you do to make your own Evennia <a class="reference internal" href="Contribs/Contribs-Overview.html"><span class="doc std std-doc">contrib</span></a> to distribute with Evennia.</p></li>
</ul>
</section>
<section id="helping-with-donations">
<h3>Helping with Donations<a class="headerlink" href="#helping-with-donations" title="Permalink to this headline">¶</a></h3>
<p>Evennia is a free and open-source project. Any monetary donations you want to offer are <em>completely voluntary</em>. While highly appreciated, we don’t expect you to donate and don’t hide any secret features behind a donation-paywall. Just see it as a way of showing appreciation by dropping a few coins in the cup.</p>
<ul class="simple">
<li><p><a class="reference external" href="https://www.patreon.com/griatch">Become an Evennia patron</a>  which donates a (usually small) sum every month to show continued support.</p></li>
<li><p><a class="reference external" href="https://www.paypal.com/paypalme/GriatchEvennia">Make a one-time donation</a> if a monthly donation is not your thing. This is a PayPal link but you don’t need PayPal yourself to use it.</p></li>
</ul>
<p>[codestyle]:: Evennia-Code-Style</p>
</section>
</section>
</section>


          </div>
        </div>
      </div>

    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="Contributing-Docs.html" title="Contributing to Evennia Docs"
             >next</a> |</li>
        <li class="right" >
          <a href="Contribs/Contrib-Tree-Select.html" title="Easy menu selection tree"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">Evennia 2.x</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">How To Contribute And Get Help</a></li> 
      </ul>
    </div>

     
    <div class="footer" role="contentinfo">
        &#169; Copyright 2023, The Evennia developer community.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
    </div>
  </body>
</html>