Skip to content

alan-if/alan-bugs-testbed

Repository files navigation

Alan Bugs Testbed

A place to submit examples of bugs in ALAN Interactive Fiction Language, in order to isolate them and fix them.

Anyone can report a bug by providing code examples to this repository via pull requests.

For any questions and discussions, either open an issue here or join the conversation via email on the Alan-IF Google group.


Table of Contents


Introduction

The Alan language is still in beta stage, it's therefore important for its development toward the first stable release to find and report any bugs encountered.

Some bugs pop-up unexpectedly during adventures creation, and it's not always easy to isolate their cause. Ideally, the best way to inform Alan developers about a bug is to extrapolate it from its context by creating a minimal viable example of its manifestation. But sometimes this is not an easy task due the complexity of the context.

Either way, this repository is the right place to publicly share examples of bugs. Publishing real code examples is much better than sending code examples pasted inside emails, and it grants Alan developers quicker access to the code.

Submitting a Bug

You can either:

  • Open an issue, and describe the bug.
  • Submit an example adventure of the bug.

The former approach is quicker and preferable for bugs that can be easily described and reproduced by anyone.

The latter is the way to go when a full example is required to demonstrate a bug.

Each example should be contributed in an isolated folder, to keep the project structure uncluttered. Clone the repository, add your example, and create a pull request.

In either case, don't forget to provide details about your OS, the version of the Alan SDK used, and a clear description of the bug.

Project Organization

Bugs examples are organized by folders.

A copy of Anssi Räisänen's 2.x (dev snapshot) is provided in oreder to allow running example adventures known to display a bug:

Useful Verbs

To reduce code typing in each test adventure, some core verbs are provided to cover basic commands:

Current Bugs Examples

folder description Alan SDK Issue status
/whitespace-bug/ inconsistent white space in room descriptions v3.0beta6 build 1880 solved
/container-limits/ TAKE ALL exceeding Limit Count crashes v3.0beta8 build 2220 #34 solved

Artistic License 2.0

This project is governed by the terms of the Artistic License 2.0.