You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
can include bug fixes, feature implementations, performance improvements, or enhancing documentation.</p>
465
+
<p><strong>Contributing to Cirrina</strong><br/>
466
+
The official runtime system for CSM is available as an <strong>open-source project</strong> on <ahref="https://github.com/CollaborativeStateMachines/Cirrina">GitHub <svgclass="iconify" xmlns="http://www.w3.org/2000/svg" width="20px" height="20px" viewBox="0 0 24 24"><pathfill="currentColor" d="M12 1C5.923 1 1 5.923 1 12c0 4.867 3.149 8.979 7.521 10.436c.55.096.756-.233.756-.522c0-.262-.013-1.128-.013-2.049c-2.764.509-3.479-.674-3.699-1.292c-.124-.317-.66-1.293-1.127-1.554c-.385-.207-.936-.715-.014-.729c.866-.014 1.485.797 1.691 1.128c.99 1.663 2.571 1.196 3.204.907c.096-.715.385-1.196.701-1.471c-2.448-.275-5.005-1.224-5.005-5.432c0-1.196.426-2.186 1.128-2.956c-.111-.275-.496-1.402.11-2.915c0 0 .921-.288 3.024 1.128a10.2 10.2 0 0 1 2.75-.371c.936 0 1.871.123 2.75.371c2.104-1.43 3.025-1.128 3.025-1.128c.605 1.513.221 2.64.111 2.915c.701.77 1.127 1.747 1.127 2.956c0 4.222-2.571 5.157-5.019 5.432c.399.344.743 1.004.743 2.035c0 1.471-.014 2.654-.014 3.025c0 .289.206.632.756.522C19.851 20.979 23 16.854 23 12c0-6.077-4.922-11-11-11"/></svg></a>.<br/>
467
+
Contributions may include:</p>
468
+
<ul>
469
+
<li>Bug fixes</li>
470
+
<li>Feature implementations</li>
471
+
<li>Performance improvements</li>
472
+
<li>Documentation enhancements</li>
473
+
</ul>
468
474
</li>
469
475
<li>
470
476
<p><strong>Research</strong><br/>
471
-
If you use CSM in your research, or build upon publications related to the project, your insights and
472
-
contributions are valuable. Relevant publications can be found <ahref="../../research/publications/">here</a>.</p>
477
+
If you use CSM in your research or build on our publications, your contributions are valuable.<br/>
478
+
Relevant publications can be found <ahref="../../research/publications/">here</a>.</p>
473
479
</li>
474
480
<li>
475
481
<p><strong>Documentation and Tutorials</strong><br/>
476
-
Improving tutorials, examples, or reference documentation is another way to support the project and make
477
-
CSM more accessible to new users.</p>
482
+
Improving tutorials, examples, and reference documentation helps make CSM more accessible to new users.</p>
478
483
</li>
479
484
</ul>
480
485
<h3id="contributing-to-cirrina">Contributing to Cirrina</h3>
481
-
<p>Cirrina is implemented in Java and Kotlin, with Kotlin being the preferred language. Contributions can be
482
-
submitted via pull requests from forks of the repository.</p>
483
-
<p>To ensure smooth collaboration: </p>
486
+
<p>Cirrina is implemented in <strong>Java</strong> and <strong>Kotlin</strong>, with <strong>Kotlin as the preferred language</strong>.</p>
487
+
<p>Contributions are submitted via <strong>pull requests</strong> from forks of the repository.</p>
488
+
<p>To ensure smooth collaboration, we:</p>
484
489
<ul>
485
-
<li>Follow <ahref="https://github.com/conventional-changelog/commitlint">commitlint</a> conventions to keep the changelog
486
-
tidy.</li>
487
-
<li>Maintain and improve test coverage through our <ahref="https://github.com/CollaborativeStateMachines/Cirrina/tree/develop/src/test/java/at/ac/uibk/dps/cirrina">unit tests</a>.
488
-
These are automatically validated via our <ahref="https://github.com/CollaborativeStateMachines/Cirrina/blob/develop/.github/workflows/build.yml">build pipeline</a>.</li>
489
-
<li>Pull requests must pass all status checks and undergo code review before merging. </li>
490
+
<li>follow <ahref="https://github.com/conventional-changelog/commitlint">commitlint</a> conventions to keep the
491
+
changelog tidy;</li>
492
+
<li>use <ahref="https://prettier.io/">Prettier</a> to format our code;</li>
493
+
<li>maintain and improve test coverage via our <ahref="https://github.com/CollaborativeStateMachines/Cirrina/tree/develop/src/test/java/at/ac/uibk/dps/cirrina">unit tests</a>
494
+
validated automatically by our <ahref="https://github.com/CollaborativeStateMachines/Cirrina/blob/develop/.github/workflows/build.yml">build pipeline</a>; and</li>
495
+
<li>let pull requests <strong>pass all status checks</strong> and undergo <strong>code review</strong> before merging. </li>
490
496
</ul>
491
-
<p>We encourage contributors to discuss major changes or new features via
492
-
<ahref="https://github.com/CollaborativeStateMachines/Cirrina/issues">GitHub issues</a> before implementation to align
493
-
with the project roadmap.</p>
494
-
<p>Additionally, for broader discussions related to the CSM project, we have a
<p><strong>If CSM is part of your research, please cite our primary publication:</strong><br/><br/></p>
499
-
<p>Marlon Etheredge, Thomas Fahringer, Felix Erlacher, Elias Kohler, Stefan Pedratscher, Juan Aznar-Poveda, Nishant Saurabh, and Adrien Lebre. Collaborative State Machines: A Better Programming Model for the Cloud-Edge-IoT Continuum. July 2025. <ahref="https://arxiv.org/abs/2507.21685">arXiv:2507.21685</a>, <ahref="https://doi.org/10.48550/arXiv.2507.21685">doi:10.48550/arXiv.2507.21685</a>.</p>
498
+
<p>For major changes or new features, please open a <ahref="https://github.com/CollaborativeStateMachines/Cirrina/issues">GitHub issue</a>
499
+
to align with the project roadmap.</p>
500
+
</div>
501
+
<divclass="admonition info">
502
+
<p>Broader discussions related to the CSM project take place on our <ahref="https://github.com/orgs/CollaborativeStateMachines/discussions">discussion board</a>.</p>
503
+
</div>
504
+
<h3id="research">Research</h3>
505
+
<p>We encourage researchers to share <strong>new findings, experiments, or insights</strong> that extend CSM. These
506
+
contributions help the project evolve and guide future development.</p>
507
+
<divclass="admonition info">
508
+
<p><strong>If CSM is part of your research, please cite our primary publication:</strong><br></p>
509
+
<p><code>Marlon Etheredge, Thomas Fahringer, Felix Erlacher, Elias Kohler, Stefan Pedratscher, Juan Aznar\-Poveda, Nishant Saurabh, and Adrien Lebre. Collaborative State Machines: A Better Programming Model for the Cloud\-Edge\-IoT Continuum. July 2025. [arXiv:2507.21685](https://arxiv.org/abs/2507.21685), [doi:10.48550/arXiv.2507.21685](https://doi.org/10.48550/arXiv.2507.21685).</code></p>
500
510
</div>
501
-
<p>You are also encouraged to share new research findings, experiments, or insights that extend the CSM
502
-
framework, as these contributions help the project evolve and guide future development.</p>
503
-
<h3id="documentation">Documentation</h3>
504
-
<p>The CSM project documentation is maintained on this website. Contributions, corrections, and enhancements are
<p>Cirrina is the official runtime system of the CSM project. Together with the CSM programming model, it is
464
-
being developed by the <ahref="https://dps.uibk.ac.at/">Distributed and Parallel Systems Group</a> at the University of
465
-
Innsbruck. </p>
466
-
<p>The runtime system is implemented in Java and Kotlin and is available as an open-source project on <ahref="https://github.com/CollaborativeStateMachines/Cirrina">Github
0 commit comments