coder guide
=============
-:Copyright: (c) 2004-2017 Jeremy Stanley <fungi@yuggoth.org>. Permission
- to use, copy, modify, and distribute this software is
- granted under terms provided in the LICENSE file distributed
- with this software.
+.. Copyright (c) 2004-2018 Jeremy Stanley <fungi@yuggoth.org>.
+ Permission to use, copy, modify, and distribute this software is
+ granted under terms provided in the LICENSE file distributed with
+ this software.
This guide attempts to embody a rudimentary set of rules for developer
submissions of source code and documentation targeted for inclusion
within the mudpy project, as well as pointers to useful resources for
those attempting to obtain a greater understanding of the software.
-.. sectnum:: :prefix: 1.
-.. contents:: :local:
-
---------
- source
---------
+source
+------
As with any project, the mudpy source code could always be better
documented, and contributions to that end are heartily welcomed.
version control system
-----------------------
+~~~~~~~~~~~~~~~~~~~~~~
Git_ is used for version control on the project, and the archive can be
cloned anonymously from http://mudpy.org/git/mudpy if desired. For now,
/#term-source-distribution-or-sdist
developer environment
----------------------
+~~~~~~~~~~~~~~~~~~~~~
Basic developer requirements are a POSIX Unix derivative (such as
Linux), a modern Python 3 interpreter (any of the minor revisions
.. _tox.ini: http://mudpy.org/gitweb?p=mudpy.git;a=blob;f=tox.ini
application program interface
------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
API documentation is maintained within docstrings in the mudpy source
code.
regression testing
-------------------
+~~~~~~~~~~~~~~~~~~
All new commits are tested using a selftest script in the
``mudpy/tests`` directory of the source archive, to help ensure the
the test configuration provided in the ``mudpy/tests/fixtures``
directory.
--------
- style
--------
+style
+-----
This project follows Guido van Rossum and Barry Warsaw's `Style Guide`_
for Python Code (a.k.a. "PEP-8"). When in need of sample code or other