Skip to content

License Change towards support for Tamarin / .spthy Language & Syntax Recognition #8

@JeuJeus

Description

@JeuJeus

In this Issue I describe the Goal of enabling Tamarin as a “supported”/recognized language on GitHub, as well as reasons for doing so and the necessary changes to start.
At the same time I volunteer to implement the necessary steps.

Goal

It would be beneficial to have support for Tamarin or more specifically its security protocol theory files (.spthy) on GitHub.

This means having the Tamarin theories listed in the repositories languages (see Screenshot from tamarin-prover/tamarin-prover attached).
image

As well as working Syntax highlighting in the GitHub Web interface for .spthy files in general.

Reasons for this

The inclusion of Tamarin into GitHubs supported languages provides benefits in the visibility and public appearance of Tamarin.
Exemplary highlighting its presence in repositories of protocols/tools utilizing Tamarin to proof their security (random example, first one that appeared in my search cloudflare/odoh-analysis).
At the same time, Tamarin would be highlighted on GitHub increasing exposure to potential new users.
Additionally, the usability of Tamarin files on GitHub would be increased due to working Syntax highlighting.
This would be largely beneficial for Diffs, Issues, and PRs.
Whilst also improving studying examples/implementations online, without the need to clone a repo for syntax highlighting support.

Necessary Changes

The process of integrating a new language for GitHub is pretty straightforward with linguist (see Adding a language).
The only real change would be the necessity to provide Syntax Highlighting and Example Code with a compatible license.
The current GPL-3.0 license is not sufficient.

Let me know if additional information is necessary, feel free to reach out to me, I am looking forward to help.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions