Untyped open source repository
==============================

Welcome to the Untyped OSS repository.

We make extensive use of open source and free software.
We could not survive without it or the people that create it.
This repository is our attempt to give something back to the community.

Please see the COPYING file in this directory for copyright notices,
licences and terms of use: they apply to everything in this repository.

We hope you have fun with our code!

-- The Untypers

Contributing patches and updates
--------------------------------

The default permissions are read-only. Patches and updates should be 
submitted by email to dave, noel, djb or matt at untyped.

Write access to the repository will be granted to trusted contributors
on an individual basis. To join the commit list, drop Matt an email (matt at
untyped).

Organisation
------------

The repository uses a standard directory structure:

  /
    PROJECT_NAME              
      trunk
        src                   - source code goes here, along with anything 
                                that should be packaged with the project
        dev                   - optional - other files go here
      branches
        BRANCH_NAME           - this directory is the equivalent of "trunk"
          src
          dev
        ...
      tags
        TAG_NAME              - this directory is the equivalent of "trunk"
          src
          dev
        ...

Every release of a PLaneT package should be tagged using an X.Y version number.
For example:

  unlib
    tags
      3.0
        src

Other tag and branch names are also permissable.

Commit notes
------------

Standard commit notes should have at least the following header line:

  PROJECT_NAME BRANCH_NAME: ONE_LINE_DESCRIPTION

For example:

  Mirrors trunk: added define-javascript-syntax form.

Detailed commit notes should be included on subsequent lines.

All commit notes should be in plain text format.

Crediting policy
----------------

We always want to issue proper credit for contributions to the code in this repository.
However, we do not include names in the source code for crediting purposes.

Typically, minor contributions such as bug fixes will result in your name being added to
the Acknowledgements page in the documentation for the project. Major contributions
may result in your name being added to the author list in an appropriate position. How
you are credited is ultimately up to Untyped, although we will not include your code
in our project unless you are satisfied with our decision.

We do take care to ensure contributions are properly credited. If you spot any omissions
or mistakes in the acknowledgements for a project please let us know.

General disclaimer
------------------   

Untyped Ltd reserves the right to do the following things at any time, without notice:
  - alter or remove any content in this repository;
  - alter or remove global or individual read and/or write permissions.