219 lines
13 KiB
HTML
219 lines
13 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>Contributing to CPL — Common Python Library documentation</title>
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<!--[if lt IE 9]>
|
||
<script src="_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/underscore.js"></script>
|
||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<script src="_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="CLI reference" href="cpl_cli.html" />
|
||
<link rel="prev" title="Using cpl g & cpl n templating" href="tutorials.templating.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<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" >
|
||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||
</a>
|
||
<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="Navigation menu">
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing to CPL</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#found-a-bug">Found a Bug?</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#feature-request">Feature Request</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#submission-guidelines">Submission Guidelines</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#submitting-an-issue">Submitting an Issue</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#submitting-a-pull-request">Submitting a Pull Request</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#reviewing-a-pull-request">Reviewing a Pull Request</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#addressing-review-feedback">Addressing review feedback</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#coding-rules">Coding Rules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#license">License</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">cpl_discord package</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">Common Python Library</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||
<li>Contributing to CPL</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="_sources/contributing.md.txt" rel="nofollow"> View page source</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="contributing-to-cpl">
|
||
<h1>Contributing to CPL<a class="headerlink" href="#contributing-to-cpl" title="Permalink to this heading"></a></h1>
|
||
<p>We would love for you to contribute to CPL and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:</p>
|
||
<ul class="simple">
|
||
<li><p><span class="xref myst">Issuses and Bugs</span></p></li>
|
||
<li><p><span class="xref myst">Feature Request</span></p></li>
|
||
<li><p><span class="xref myst">Submission Guidelines</span></p></li>
|
||
<li><p><span class="xref myst">Coding Rules</span></p></li>
|
||
<li><p><span class="xref myst">License</span></p></li>
|
||
</ul>
|
||
<section id="found-a-bug">
|
||
<h2>Found a Bug?<a class="headerlink" href="#found-a-bug" title="Permalink to this heading"></a></h2>
|
||
<p>If you find a bug in the source code, you can help us by <span class="xref myst">submitting an issue</span> to our <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">Gitea Repository</a>. Even better, you can <span class="xref myst">submit a Pull Request</span> with a fix.</p>
|
||
</section>
|
||
<section id="feature-request">
|
||
<h2>Feature Request<a class="headerlink" href="#feature-request" title="Permalink to this heading"></a></h2>
|
||
<p>You can request a new feature by submitting an issue to our <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">Gitea Repository</a>. If you would like to implement a new feature, please consider the size of the change in order to determine the right steps to proceed:</p>
|
||
<p>For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.</p>
|
||
<p>Note: Adding a new topic to the documentation, or significantly re-writing a topic, counts as a major feature.</p>
|
||
<p>Small Features can be crafted and directly submitted as a <span class="xref myst">Pull Request</span>.</p>
|
||
</section>
|
||
<section id="submission-guidelines">
|
||
<h2>Submission Guidelines<a class="headerlink" href="#submission-guidelines" title="Permalink to this heading"></a></h2>
|
||
<section id="submitting-an-issue">
|
||
<h3>Submitting an Issue<a class="headerlink" href="#submitting-an-issue" title="Permalink to this heading"></a></h3>
|
||
<p>Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.</p>
|
||
<p>We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we require that you provide a minimal reproduction. Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions.</p>
|
||
<p>A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem.</p>
|
||
<p>We require a minimal reproduction to save maintainers’ time and ultimately be able to fix more bugs. Often, developers find coding problems themselves while preparing a minimal reproduction. We understand that sometimes it might be hard to extract essential bits of code from a larger codebase but we really need to isolate the problem before we can fix it.</p>
|
||
<p>Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don’t hear back from you, we are going to close an issue that doesn’t have enough info to be reproduced.</p>
|
||
</section>
|
||
<section id="submitting-a-pull-request">
|
||
<h3>Submitting a Pull Request<a class="headerlink" href="#submitting-a-pull-request" title="Permalink to this heading"></a></h3>
|
||
<p>Before you submit your Pull Request (PR) consider the following guidelines:</p>
|
||
<ol class="arabic">
|
||
<li><p>Search the <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">repository</a> for an open or closed PR that relates to your submission. You don’t want to duplicate existing efforts.</p></li>
|
||
<li><p>Be sure that an issue describes the problem you’re fixing, or documents the design for the feature you’d like to add. Discussing the design upfront helps to ensure that we’re ready to accept your work.</p></li>
|
||
<li><p>Fork the sh-edraft.de/cpl repo.</p></li>
|
||
<li><p>In your forked repository, make your changes in a new git branch:</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>checkout<span class="w"> </span>-b<span class="w"> </span>my-fix-branch<span class="w"> </span>master
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
<li><p>Create your patch, including appropriate test cases.</p></li>
|
||
</ol>
|
||
<!-- 6. Follow our [Coding Rules](coding-rules). -->
|
||
<ol class="arabic" start="6">
|
||
<li><p>Commit your changes.</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>commit<span class="w"> </span>--all
|
||
</pre></div>
|
||
</div>
|
||
<p>Note: the optional commit <code class="docutils literal notranslate"><span class="pre">-a</span></code> command line option will automatically “add” and “rm” edited files.</p>
|
||
</li>
|
||
<li><p>Push your branch to the <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">repository</a>:</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>push<span class="w"> </span>origin<span class="w"> </span>my-fix-branch
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
<li><p>In Gitea, send a pull request to cpl:master</p></li>
|
||
</ol>
|
||
</section>
|
||
<section id="reviewing-a-pull-request">
|
||
<h3>Reviewing a Pull Request<a class="headerlink" href="#reviewing-a-pull-request" title="Permalink to this heading"></a></h3>
|
||
<p>The sh-edraft.de team reserves the right not to accept pull requests from community members who haven’t been good citizens of the community. Such behavior includes not following the CPL <span class="xref myst">coding rules</span> and applies within or outside of CPL managed channels.</p>
|
||
<section id="addressing-review-feedback">
|
||
<h4>Addressing review feedback<a class="headerlink" href="#addressing-review-feedback" title="Permalink to this heading"></a></h4>
|
||
<p>If we ask for changes via code reviews then:</p>
|
||
<ol class="arabic">
|
||
<li><p>Make the required updates to the code.</p></li>
|
||
<li><p>Create a fixup commit and push to your repository (this will update your Pull Request):</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>commit<span class="w"> </span>--all<span class="w"> </span>--fixup<span class="w"> </span>HEAD
|
||
git<span class="w"> </span>push
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
</ol>
|
||
<p>That’s it! Thank you for your contribution!</p>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
<section id="coding-rules">
|
||
<h2>Coding Rules<a class="headerlink" href="#coding-rules" title="Permalink to this heading"></a></h2>
|
||
<p>To ensure consistency throughout the source code, keep these rules in mind as you are working:</p>
|
||
<ul class="simple">
|
||
<li><p>All features or bug fixes must be tested by one or more unit-tests.</p></li>
|
||
<li><p>All public API methods must be documented.</p></li>
|
||
<li><p>We follow <a class="reference external" href="https://www.python.org/dev/peps/pep-0008/">PEP 8 – Style Guide for Python Code</a>.</p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="license">
|
||
<h2>License<a class="headerlink" href="#license" title="Permalink to this heading"></a></h2>
|
||
<p>By contributing, you agree that your contributions will be licensed under its MIT License.
|
||
See <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/cpl/src/branch/master/LICENSE">LICENSE</a></p>
|
||
<!-- LINKS -->
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="tutorials.templating.html" class="btn btn-neutral float-left" title="Using cpl g & cpl n templating" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="cpl_cli.html" class="btn btn-neutral float-right" title="CLI reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |