.. vim: set filetype=rst fileencoding=utf-8:
.. -*- coding: utf-8 -*-
.. +--------------------------------------------------------------------------+
   |                                                                          |
   | Licensed under the Apache License, Version 2.0 (the "License");          |
   | you may not use this file except in compliance with the License.         |
   | You may obtain a copy of the License at                                  |
   |                                                                          |
   |     http://www.apache.org/licenses/LICENSE-2.0                           |
   |                                                                          |
   | Unless required by applicable law or agreed to in writing, software      |
   | distributed under the License is distributed on an "AS IS" BASIS,        |
   | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
   | See the License for the specific language governing permissions and      |
   | limitations under the License.                                           |
   |                                                                          |
   +--------------------------------------------------------------------------+


:tocdepth: 3


*******************************************************************************
Contribution
*******************************************************************************

Contribution to this project is welcome! However, it must follow the :doc:`code
of conduct <common/conduct>` for the project.


Ways to Contribute
===============================================================================

* File bug reports and feature requests in the `issue tracker
  <https://github.com/emcd/python-project-common/issues>`_. (Please try
  to avoid duplicate issues.)

* Fork the repository and submit `pull requests
  <https://github.com/emcd/python-project-common/pulls>`_ to improve the
  source code or documentation. Pull requests should follow the development
  guidance and standards below.


Development
===============================================================================

Guidance and Standards
-------------------------------------------------------------------------------

* Follow the :doc:`development environment preparation and management
  instructions <common/environment>` to ensure consistency with maintainer
  development environments and CI workflows.

* Adhere to the :doc:`development practices <common/practices>` and :doc:`code
  style <common/style>` to improve the probability of pull request acceptance.
  You may wish to use an LLM to assist with this, if the standards seem too
  onerous or specific.

* Also consider the :doc:`nomenclature advice <common/nomenclature>` for
  consistency and to improve the probability of pull request acceptance.

* Prepare changelog fragments according to the :doc:`releases guide
  <common/releases>` as appropriate.

* Although unncessary for non-maintainer contributions, additional background
  can be found in the :doc:`maintenance guide <common/maintenance>`.

Resources
-------------------------------------------------------------------------------

.. toctree::
   :maxdepth: 2

   devapi
   common/conduct
   common/environment
   common/practices
   common/style
   common/nomenclature
   common/releases
   common/maintenance