tahoe-lafs/.github/CONTRIBUTING.rst

.. -*- coding: utf-8 -*-

.. This document is rendered on the GitHub PR creation page to guide
   contributors.  It is also rendered into the overall documentation.

Contributing to Tahoe-LAFS
==========================

As an open source project,
Tahoe-LAFS welcomes contributions of many forms.

Examples of contributions include:

* `Code patches <https://tahoe-lafs.org/trac/tahoe-lafs/wiki/Patches>`_
* `Documentation improvements <https://tahoe-lafs.org/trac/tahoe-lafs/wiki/Doc>`_
* `Bug reports <https://tahoe-lafs.org/trac/tahoe-lafs/wiki/HowToReportABug>`_
* `Patch reviews <https://tahoe-lafs.org/trac/tahoe-lafs/wiki/PatchReviewProcess>`_

Before authoring or reviewing a patch,
please familiarize yourself with the `Coding Standards <https://tahoe-lafs.org/trac/tahoe-lafs/wiki/CodingStandards>`_ and the `Contributor Code of Conduct <../docs/CODE_OF_CONDUCT.md>`_.
Skeleton that mostly links to existing documentation 2019-03-15 17:11:21 +00:00			`.. -- coding: utf-8 --`

			`.. This document is rendered on the GitHub PR creation page to guide`
			`contributors. It is also rendered into the overall documentation.`

			`Contributing to Tahoe-LAFS`
			`==========================`

			`As an open source project,`
			`Tahoe-LAFS welcomes contributions of many forms.`

			`Examples of contributions include:`

			* `Code patches <https://tahoe-lafs.org/trac/tahoe-lafs/wiki/Patches>`_
			* `Documentation improvements <https://tahoe-lafs.org/trac/tahoe-lafs/wiki/Doc>`_
			* `Bug reports <https://tahoe-lafs.org/trac/tahoe-lafs/wiki/HowToReportABug>`_
			* `Patch reviews <https://tahoe-lafs.org/trac/tahoe-lafs/wiki/PatchReviewProcess>`_

			`Before authoring or reviewing a patch,`
try to link to the same thing more robustly 2021-01-26 14:58:08 +00:00			please familiarize yourself with the `Coding Standards <https://tahoe-lafs.org/trac/tahoe-lafs/wiki/CodingStandards>`_ and the `Contributor Code of Conduct <../docs/CODE_OF_CONDUCT.md>`_.