+++ /dev/null
-=============
- coder guide
-=============
-
-:Copyright: (c) 2004-2014 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
---------
-
-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,
-detailed commits can be E-mailed to fungi@yuggoth.org, but there will
-most likely be a developer mailing list for more open presentation and
-discussion of patches soon.
-
-A Gitweb_ interface is available, to make the change history easier to
-browse. This is found at http://mudpy.org/gitweb/mudpy/ and should be
-fairly self-explanatory.
-
-A GNU-format_ ChangeLog file is generated automatically from repository
-commit logs, available at http://mudpy.org/res/src/mudpy/doc/ChangeLog
-and is included in the doc directory of all tarball/zip files. The
-export script, git2gch, is included in the bin directory.
-
-.. _Git: http://git-scm.com/
-.. _Gitweb: http://git.wiki.kernel.org/index.php/Gitweb
-.. _GNU-format: http://www.gnu.org/prep/standards/html_node
- /Style-of-Change-Logs.html#Style-of-Change-Logs
-
-application program interface
------------------------------
-
-API documentation is maintained within docstrings in the mudpy source
-code.
-
-regression testing
-------------------
-
-All new commits are tested using a regression testing script in the bin
-directory of the source archive, to help ensure the software is
-continually usable. Any new features should be accompanied by suitable
-regression tests so that their functionality can be maintained properly
-through future releases.
-
--------
- 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
-examples, any common source code file or text document file distributed
-as part of mudpy should serve as a suitable reference. Testing of all
-new patches with the flake8_ and pylint_ utilities is also highly
-recommended.
-
-.. _Style Guide: http://www.python.org/dev/peps/pep-0008/
-.. _flake8: https://pypi.python.org/pypi/flake8
-.. _pylint: https://pypi.python.org/pypi/pylint
projects / mudpy.git / blobdiff