propensive/tumult

Github action for repository maintenance

${TITLE}

${SLOGAN}

${INTRO}

Features

${FEATURES}

Availability

${TITLE} has not yet been published as a binary. It is currently waiting for the final release of Scala 3.3.

Getting Started

${BASICS}

Status

${TITLE} is classified as ${STATUS}. For reference, Scala One projects are categorized into one of the following five stability levels:

• embryonic: for experimental or demonstrative purposes only, without any guarantees of longevity
• fledgling: of proven utility, seeking contributions, but liable to significant redesigns
• maturescent: major design decisions broady settled, seeking probatory adoption and refinement
• dependable: production-ready, subject to controlled ongoing maintenance and enhancement; tagged as version 1.0.0 or later
• adamantine: proven, reliable and production-ready, with no further breaking changes ever anticipated

Projects at any stability level, even embryonic projects, are still ready to be used, but caution should be taken if there is a mismatch between the project's stability level and the importance of your own project.

${TITLE} is designed to be small. Its entire source code currently consists of ${LOC} lines of code.

Building

${TITLE} can be built on Linux or Mac OS with Fury, however the approach to building is currently in a state of flux, and is likely to change.

Contributing

Contributors to ${TITLE} are welcome and encouraged. New contributors may like to look for issues marked beginner.

We suggest that all contributors read the Contributing Guide to make the process of contributing to ${TITLE} easier.

Please do not contact project maintainers privately with questions unless there is a good reason to keep them private. While it can be tempting to repsond to such questions, private answers cannot be shared with a wider audience, and it can result in duplication of effort.

Author

${TITLE} was designed and developed by Jon Pretty, and commercial support and training is available from Propensive OÜ.

${THANKS}

Name

${NAME}

In general, Scala One project names are always chosen with some rationale, however it is usually frivolous. Each name is chosen for more for its uniqueness and intrigue than its concision or catchiness, and there is no bias towards names with positive or "nice" meanings—since many of the libraries perform some quite unpleasant tasks.

Names should be English words, though many are obscure or archaic, and it should be noted how willingly English adopts foreign words. Names are generally of Greek or Latin origin, and have often arrived in English via a romance language.

License

${TITLE} is copyright © ${COPYRIGHT} Jon Pretty & Propensive OÜ, and is made available under the Apache 2.0 License.