.. vim: set 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.                                           |
   |                                                                          |
   +--------------------------------------------------------------------------+

.. include:: <isopub.txt>

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

Contribution to this project is welcome!
Here are some ways that you can help:

* Filing `issues <https://github.com/emcd/python-devshim/issues>`_
  for bug reports, feature requests, and other relevant discussion.
* Helping out with the development_ of the source code and documentation.

Please do note that all interactions about this project
on media under its control are subject to its `Code of Conduct`_.

Code of Conduct
===============================================================================

Please take a look at:

* `How do I ask a good question? <https://stackoverflow.com/help/how-to-ask>`_

* `How to Ask Questions the Smart Way
  <http://www.catb.org/~esr/faqs/smart-questions.html>`_ (but understand that
  some of the showcased responses to "stupid questions" may not be acceptable)

* `How do I write a good answer?
  <https://stackoverflow.com/help/how-to-answer>`_

* `Python Software Foundation Code of Conduct
  <https://www.python.org/psf/conduct/>`_ (in particular, the ``Our Community``
  and ``Our Standards: Inappropriate Behavior`` sections)

as well as note the following bullet points from the `Rust Code of Conduct
<https://www.rust-lang.org/policies/code-of-conduct>`_:

  |bull| Respect that people have differences of opinion and that every design
  or implementation choice carries a trade-off and numerous costs. There is
  seldom a right answer.

  |bull| Please keep unstructured critique to a minimum. If you have solid
  ideas you want to experiment with, make a fork and see how it works.

  |bull| Likewise any spamming, trolling, flaming, baiting or other
  attention-stealing behavior is not welcome.

.. note:: Please do not contact the authors of the above documents
          for anything related to this project.

Please act in the spirit of respect for others, whether you are asking
questions, providing feedback, or answering questions. Please remember that
volunteerism by real human beings, like yourself, powers much of the open
source available for you to use.

Also, no need to create noise with "+1" or "me too" comments in issue
tracker threads. Please only add substantive comments that will further advance
the understanding of an issue. If you wish to upvote a comment, then please use
an appropriate reacji on that comment.

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

.. toctree::
   :maxdepth: 3

   development/environment
   development/design
   development/common-tasks
   development/practices