Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Actor-based Toolkit for Interactive Language Education in Python
Python

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
demo
doc
layouts
pelita
test
tournament
.gitattributes
.gitignore
COPYING
README.md
check_boilerplate.sh
commit-doc-tree.sh
pelitagame
pelitaviewer
summary.sh

README.md

Pelita

Description

Autonomous agent environment for Python summerschool.

Coding conventions

  • Docstrings should follow the Numpy convention
  • Use old-style print statement (not the function)
  • For internal messages, use the logging module with an appropriate logging level, which makes their appearance completely configurable.
  • Use old-style format-string, i.e. "%s" % (val)) instead of "{0}".format(val)

Git-Repository

Layout and Branch Model

We use the gitflow model with the following settings:

  • Branch name for production releases: [master]
  • Branch name for "next release" development: [develop]
  • How to name your supporting branch prefixes?
  • Feature branches? [feature/]
  • Release branches? [release/]
  • Hotfix branches? [hotfix/]
  • Support branches? [support/]
  • Version tag prefix? [v]

Only feature/ branches are subject to rebase/rewind. All others should remain stable

Commit Markers

Commits should be marked. Declare both functionality and area.

Functionality Markers

  • BF : bug fix
  • RF : refactoring
  • NF : new feature
  • ENH : enhancement of an existing feature/facility
  • BW : addresses backward-compatibility
  • OPT : optimization
  • BK : breaks something and/or tests fail
  • FO : code formatting (adding spaces etc.)
  • PL : making pylint happier

Code Area Markers

  • DOC : documentation
  • UT : unit tests
  • BLD : build-system, setup.py
  • GIT : repository mods, e.g. .gitconfig .gitattributes

Example

  • DOC/ENH: add initial README.md

Website

Something went wrong with that request. Please try again.