Merge branch 'main' of github.com:propensive/yossarian

.github/contributing.md

@@ -0,0 +1,88 @@
+<img src="/doc/images/200x200.png" align="right">
+
+# Contributing to Yossarian
+
+Firstly, thank you for taking an interesting in contributing! Yossarian is an
+open-source project, and welcomes contributions in the form of feature code,
+bug reports and fixes, tests, feature suggestions and anything else which may
+help to make it better software.
+
+Yossarian is one of a large number of
+[Soundness](https://github.com/propensive/soundness/) projects, which benefit
+from having consistent integrations and automated admin tasks. These will be
+developed across all projects simultaneously, and there's a roadmap for
+improving them. So we are not currently looking for enhancements in this area,
+but you're welcome to enquire.
+
+## Before Starting
+
+It&rsquo;s a good idea to [discuss](https://discord.gg/MBUrkTgMnA) potential
+changes with one of the maintainers before starting work. Although efforts are
+made to document future development work using the [issue tracker](/issues), it
+will not always be up-to-date, and the maintainers may have useful information
+to share on plans.
+
+A bad scenario would be for a contributor to spend a lot of time producing a
+pull request, only for it to be rejected by the maintainers for being
+inconsistent with their plans. A quick conversation before starting work can
+save a lot of time.
+
+If a response is not forthcoming in the [Discord
+chatroom](https://discord.gg/MBUrkTgMnA), open a [GitHub
+issue](https://github.com/propensive/yossarian/issues) or contact the project
+maintainer directly _but publicly_. Please __do not__ contact the maintainer
+about technical issues privately, as it misses a good opportunity to share
+knowledge with a wider audience, unless there is a good reason to do so. Jon
+Pretty can usually be contacted [on X](https://x.com/propensive).
+
+All development work&mdash;whether bugfixing or implementing new
+features&mdash;should have a corresponding issue before work starts. If you
+have commit rights to the `propensive/yossarian` repository, push to a branch named
+after the issue number, prefixed with `issue/`, for example, `issue/23`.
+
+## Contribution standards
+
+Pull requests should try to follow the coding style of existing code in the
+repository. They are unlikely to be rejected on grounds of formatting, except
+in extreme cases. Yossarian does not use automatic code-formatting because it
+has proven to produce unreliable and unsatisfactory results (and furthermore,
+hand-formatting is not particularly laborious).
+
+Unfortunately an official coding style guide does not yet exist.
+
+Any code that is inconsistently formatted will be tidied up, if necessary, by
+the project maintainers, though well-formatted code is appreciated.
+
+## Code reviews
+
+Pull requests should have at least one review before being merged. When opening
+a pull request, contributors are welcome to suggest a reviewer. Pull requests
+should be left in _draft_ mode until they are believed to be ready for review.
+
+The preferred method of reviewing a pull request is to schedule a video call
+with the reviewer and talk through it. It is much faster to share understanding
+between the contributor and reviewer this way.
+
+For code contributions, we prefer pull requests with corresponding tests, if
+that's appropriate. Changes which break existing tests, however, are likely to
+be rejected during review.
+
+## Reporting issues
+
+New issues are welcome, both as bug reports and feature suggestions. More
+precision is preferable, and the clearest and most detailed reports will most
+likely be addressed sooner, but a short report from a busy developer is still
+preferred over a bug we never hear about. We will ask for more detail in triage
+if it&rsquo;s needed.
+
+## Conduct
+
+Contributors and other participants in online discussions are expected to be
+civil, on-topic and to nurture a pleasant development environment for all
+Yossarian&rsquo;s users. Individualism is valued, and nobody should feel
+constrained in how they express themselves, as long as they adhere to the
+expectations.
+
+Propensive O&Uuml; have some powers to address conduct issues, but that will
+start with an informal conversation, and without prejudice.
+

readme.md → .github/readme.md

@@ -1,5 +1,5 @@
 [<img alt="GitHub Workflow" src="https://img.shields.io/github/actions/workflow/status/propensive/yossarian/main.yml?style=for-the-badge" height="24">](https://github.com/propensive/yossarian/actions)
-[<img src="https://img.shields.io/discord/633198088311537684?color=8899f7&label=DISCORD&style=for-the-badge" height="24">](https://discord.gg/7b6mpF6Qcf)
+[<img src="https://img.shields.io/discord/633198088311537684?color=8899f7&label=DISCORD&style=for-the-badge" height="24">](https://discord.com/invite/MBUrkTgMnA)
 <img src="/doc/images/github.png" valign="middle">
 
 # Yossarian
@@ -21,17 +21,9 @@ position, and hyperlinks.
 - take snapshots of the terminal
 
 
-## Availability Plan
+## Availability
 
-Yossarian has not yet been published. The medium-term plan is to build Yossarian
-with [Fury](https://github.com/propensive/fury) and to publish it as a source build on
-[Vent](https://github.com/propensive/vent). This will enable ordinary users to write and build
-software which depends on Yossarian.
 
-Subsequently, Yossarian will also be made available as a binary in the Maven
-Central repository. This will enable users of other build tools to use it.
-
-For the overeager, curious and impatient, see [building](#building).
 
 ## Getting Started
 

doc/lines.md

@@ -0,0 +1 @@
+441