<h1 class="title">Compassion Sponsorships</h1> <p><a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/CompassionCH/compassion-modules/tree/11.0/sponsorship_compassion"><img alt="CompassionCH/compassion-modules" src="https://img.shields.io/badge/github-CompassionCH%2Fcompassion--modules-lightgray.png?logo=github" /></a></p> <p>Sponsorship management module. This module makes the link between child and contracts. It also customize contracts to fit the child sponsorship context.</p> <p><strong>Table of contents</strong></p> <div class="contents local topic" id="contents"> <ul class="simple"> <li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li> <li><a class="reference internal" href="#usage" id="id2">Usage</a></li> <li><a class="reference internal" href="#known-issues-roadmap" id="id3">Known issues / Roadmap</a></li> <li><a class="reference internal" href="#bug-tracker" id="id4">Bug Tracker</a></li> <li><a class="reference internal" href="#credits" id="id5">Credits</a><ul> <li><a class="reference internal" href="#authors" id="id6">Authors</a></li> <li><a class="reference internal" href="#contributors" id="id7">Contributors</a></li> <li><a class="reference internal" href="#maintainers" id="id8">Maintainers</a></li> </ul> </li> </ul> </div> <a name="configuration"></a> <h2><a class="toc-backref" href="#id1">Configuration</a></h2> <p>You can configure how to behave when projects are suspended. If you setup nothing, sponsorship invoices for a period during a suspension of a projects will be cancelled.</p> <p>If you want to change sponsorship with a fund donation, you can add the following key-value in the System Parameters:</p> <ul class="simple"> <li>sponsorship_compassion.suspend_product_id : product_id</li> </ul> <a name="usage"></a> <h2><a class="toc-backref" href="#id2">Usage</a></h2> <p>To use this module, you need to:</p> <ul class="simple"> <li>go to Sponsorship -&gt; Sponsorships</li> </ul> <a name="known-issues-roadmap"></a> <h2><a class="toc-backref" href="#id3">Known issues / Roadmap</a></h2> <ul class="simple"> <li>Tests for R4 : test the hold states when sending commitments to GMC</li> <li>Test end sponsorship wizard</li> </ul> <a name="bug-tracker"></a> <h2><a class="toc-backref" href="#id4">Bug Tracker</a></h2> <p>Bugs are tracked on <a class="reference external" href="https://github.com/CompassionCH/compassion-modules/issues">GitHub Issues</a>. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed <a class="reference external" href="https://github.com/CompassionCH/compassion-modules/issues/new?body=module:%20sponsorship_compassion%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p> <p>Do not contact contributors directly about support or help with technical issues.</p> <a name="credits"></a> <h2><a class="toc-backref" href="#id5">Credits</a></h2> <a name="authors"></a> <h3><a class="toc-backref" href="#id6">Authors</a></h3> <ul class="simple"> <li>Compassion CH</li> </ul> <a name="contributors"></a> <h3><a class="toc-backref" href="#id7">Contributors</a></h3> <ul class="simple"> <li>Cyril Sester &lt;<a class="reference external" href="mailto:cyril.sester&#64;outlook.com">cyril.sester&#64;outlook.com</a>&gt;</li> <li>Emanuel Cino &lt;<a class="reference external" href="mailto:ecino&#64;compassion.ch">ecino&#64;compassion.ch</a>&gt;</li> <li>Quentin Gigon &lt;<a class="reference external" href="mailto:gigon.quentin&#64;gmail.com">gigon.quentin&#64;gmail.com</a>&gt;</li> </ul> <a name="maintainers"></a> <h3><a class="toc-backref" href="#id8">Maintainers</a></h3> <p>This module is maintained by Compassion Switzerland.</p> <a class="reference external image-reference" href="https://www.compassion.ch"><img alt="Compassion Switzerland" src="https://upload.wikimedia.org/wikipedia/en/8/83/CompassionInternationalLogo.png" /></a> <p>Compassion Switzerland is a nonprofit organization whose mission is to release children from extreme poverty in Jesus name.</p> <p>This module is part of the <a class="reference external" href="https://github.com/CompassionCH/compassion-modules/tree/11.0/sponsorship_compassion">CompassionCH/compassion-modules</a> project on GitHub.</p>