<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Contributing to Sponge — Sponge 6.0.0 documentation</title>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/spongedocs.css" type="text/css" />
<link rel="index" title="Index"
href="../genindex.html"/> <link rel="search" title="Search" href="../search.html"/> <link rel="top" title="Sponge 6.0.0 documentation" href="../index.html"/> <link rel="next" title="Contribution Guidelines" href="guidelines.html"/> <link rel="prev" title="Download Project Version" href="../ore/routes/download.html"/>
<!-- Google Analytics -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-59476017-2', 'auto');
ga('send', 'pageview');
</script>
<script src="../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<div id="sp-logo-container" class="page-scroll">
<a class="logo" href="../index.html">
<img src="../_static/spongie-mark-dark.svg">
<span>Sponge</span>
<i class="fa fa-fw fa-chevron-down"></i>
</a>
<div id="sp-logo-menu">
<ul id="sp-logo-dropdown">
<li><a href="https://www.spongepowered.org"><i class="fa-fw fa fa-home"></i>Homepage</a></li>
<li><a href="https://forums.spongepowered.org"><i class="fa-fw fa fa-comments"></i>Forums</a></li>
<li><a href="https://github.com/SpongePowered"><i class="fa-fw fa fa-code"></i>Code</a></li>
<li class="active"><a href="https://docs.spongepowered.org"><i class="fa-fw fa fa-book"></i>Docs</a></li>
<li><a href="https://jd.spongepowered.org"><i class="fa-fw fa fa-graduation-cap"></i>Javadocs</a></li>
<li><a href="https://forums.spongepowered.org/c/plugins/plugin-releases"><i class="fa-fw fa fa-plug"></i>Plugins</a></li>
<li><a href="https://www.spongepowered.org/downloads"><i class="fa-fw fa fa-download"></i>Downloads</a></li>
<li><a href="https://www.spongepowered.org/chat"><i class="fa-fw fa fa-comment"></i>Chat</a></li>
</ul>
</div>
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../server/index.html">Creating a Server</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../preparing/index.html">Preparing for Development</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../plugin/index.html">Creating a Plugin</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../ore/index.html">Ore Documentation</a></li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing to Sponge</a><ul>
<li class="toctree-l2"><a class="reference internal" href="guidelines.html">Contribution Guidelines</a></li>
<li class="toctree-l2"><a class="reference internal" href="howtogit.html">How to Git(Hub)</a></li>
<li class="toctree-l2"><a class="reference internal" href="implementation/index.html">Developing Sponge</a></li>
<li class="toctree-l2"><a class="reference internal" href="spongedocs.html">SpongeDocs Writing</a></li>
<li class="toctree-l2"><a class="reference internal" href="porting.html">Porting Sponge to Other Platforms</a></li>
<li class="toctree-l2"><a class="reference internal" href="versioning.html">Versioning System and Repository Branch Layout</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../about/index.html">About the Sponge Project</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Sponge</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> »</li>
<li>Contributing to Sponge</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/SpongePowered/SpongeDocs/blob/Update-to-API6/source/contributing/index.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="contributing-to-sponge">
<h1>Contributing to Sponge<a class="headerlink" href="#contributing-to-sponge" title="Permalink to this headline">¶</a></h1>
<p>This sections intends to show you ways to get involved with Sponge.</p>
<div class="section" id="what-are-the-projects-i-can-help-with">
<h2>What are the projects I can help with?<a class="headerlink" href="#what-are-the-projects-i-can-help-with" title="Permalink to this headline">¶</a></h2>
<p>The Sponge Project and its parts are maintained on <a class="reference external" href="https://github.com/spongepowered">GitHub</a>. If you’re unfamiliar
with GitHub and the tool git, then take a look at <a class="reference internal" href="howtogit.html"><span class="doc">How to Git(Hub)</span></a> first. A read of our <a class="reference internal" href="guidelines.html"><span class="doc">Contribution Guidelines</span></a> is strongly
advised before starting any work. There are several projects we’re currently maintaining:</p>
<ul class="simple">
<li>SpongeAPI</li>
<li>SpongeForge</li>
<li>SpongeVanilla</li>
<li>SpongeCommon</li>
<li>Mixin</li>
<li>SpongeDocs</li>
<li>Ore</li>
</ul>
<p>If you want to know more about the structure of the project and how everything is tied together, head over to
<a class="reference internal" href="../about/structure.html"><span class="doc">The Structure of the Sponge Project</span></a>.</p>
</div>
<div class="section" id="what-kind-of-help-is-needed">
<h2>What kind of help is needed?<a class="headerlink" href="#what-kind-of-help-is-needed" title="Permalink to this headline">¶</a></h2>
<div class="section" id="basic-contributions">
<h3>Basic contributions<a class="headerlink" href="#basic-contributions" title="Permalink to this headline">¶</a></h3>
<p>This can be done by almost everyone. You don’t need to know a programming language like Java or Python to:</p>
<ul class="simple">
<li>test SpongeForge or SpongeVanilla and report bugs or usage quirks</li>
<li>report or suggest any errors, faults or bugs you encounter</li>
<li>post suggestions or idea you have which would make Sponge better</li>
</ul>
<p>Reporting bugs best via our <a class="reference external" href="https://github.com/spongepowered/">GitHub repositories</a>, suggestions fit onto our
<a class="reference external" href="https://forums.spongepowered.org/">forums</a>. Just have a look at our
<a class="reference internal" href="../server/spongineer/bugreport.html"><span class="doc">Bug Reporting page</span></a> for further instructions.</p>
</div>
<div class="section" id="intermediate-contributions">
<h3>Intermediate Contributions<a class="headerlink" href="#intermediate-contributions" title="Permalink to this headline">¶</a></h3>
<p>You should at least have basic knowledge of Java, Python or reST to help out on the following tasks:</p>
<ul class="simple">
<li>help fixing bugs</li>
<li>finish the implementation of the API (SpongeForge and SpongeVanilla)</li>
<li><a class="reference internal" href="spongedocs.html"><span class="doc">help writing the SpongeDocs</span></a></li>
<li>help <a class="reference external" href="https://crowdin.com/project/sponge-docs">translate the Docs on Crowdin</a></li>
<li>help out developing Ore</li>
</ul>
<p>The development of the <a class="reference external" href="https://github.com/spongepowered/SpongeAPI">Sponge API</a>,
<a class="reference external" href="https://github.com/spongepowered/SpongeForge">SpongeForge</a>,
<a class="reference external" href="https://github.com/spongepowered/SpongeVanilla">SpongeVanilla</a> and <a class="reference external" href="https://github.com/spongepowered/Ore">Ore</a> as
well as the <a class="reference external" href="https://github.com/spongepowered/SpongeDocs">SpongeDocs</a> is done in several repositories hosted on GitHub.</p>
</div>
<div class="section" id="advanced-contributions">
<h3>Advanced Contributions<a class="headerlink" href="#advanced-contributions" title="Permalink to this headline">¶</a></h3>
<p>And finally these are the most difficult things you can help out with. Advanced knowledge of Java, Minecraft and at
least basic knowledge of the <a class="reference external" href="https://github.com/spongepowered/SpongeAPI">Sponge API</a> and its
<a class="reference external" href="https://jd.spongepowered.org">structure</a> is strongly advised before attempting to help out with:</p>
<ul class="simple">
<li>adding functionality to the API (<a class="reference internal" href="implementation/pr.html"><span class="doc">Submitting a Pull-Request</span></a>)</li>
<li>implementing advanced API functionality in the implementations</li>
</ul>
</div>
</div>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="guidelines.html">Contribution Guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="howtogit.html">How to Git(Hub)</a></li>
<li class="toctree-l1"><a class="reference internal" href="implementation/index.html">Developing Sponge</a><ul>
<li class="toctree-l2"><a class="reference internal" href="implementation/codestyle.html">Code Style</a></li>
<li class="toctree-l2"><a class="reference internal" href="implementation/git-implementation.html">Git Workflow for API and Implementations</a></li>
<li class="toctree-l2"><a class="reference internal" href="implementation/pr.html">Submitting a Pull-Request</a></li>
<li class="toctree-l2"><a class="reference internal" href="implementation/debugging.html">Debugging Sponge Within the IDE</a></li>
<li class="toctree-l2"><a class="reference internal" href="implementation/mixins.html">Mixins</a></li>
<li class="toctree-l2"><a class="reference internal" href="implementation/datamanipulator.html">Implementing DataManipulators</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="spongedocs.html">SpongeDocs Writing</a></li>
<li class="toctree-l1"><a class="reference internal" href="porting.html">Porting Sponge to Other Platforms</a></li>
<li class="toctree-l1"><a class="reference internal" href="versioning.html">Versioning System and Repository Branch Layout</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="guidelines.html" class="btn btn-neutral float-right" title="Contribution Guidelines" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../ore/routes/download.html" class="btn btn-neutral" title="Download Project Version" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2014-2017, Sponge Contributors.
</p>
</div>Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<i class="fa fa-book"> <span>SpongeDocs</span></i>
v: 6.0.0
<span class="fa fa-caret-down"></span>
</span>
<div id="versions" class="rst-other-versions">
<dl>
<dt>Contribute</dt>
<dd><a href="https://github.com/SpongePowered/SpongeDocs/blob/Update-to-API6/source/contributing/index.rst">Source</a></dd>
<dd><a href="https://github.com/SpongePowered/SpongeDocs/edit/Update-to-API6/source/contributing/index.rst">Edit</a></dd>
</dl>
</div>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.0.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/spongedocs.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>