deploy: 0df22b4

community/contributing/index.html

@@ -6,7 +6,7 @@
 <button class="form-control sidebar-search js-search d-none d-md-flex">
 <i class="fas fa-search pr-2"></i>
 <span class=sidebar-search-text>Search...</span>
-<span class=sidebar-search-shortcut>/</span></button></form><nav class="collapse docs-links" id=docs-nav><ul class="nav docs-sidenav"><li><a href=../../community/></a></li><div class=docs-toc-item><a class="docs-toc-link active" href=../../community/contributing/>Contributing</a></div><div class=docs-toc-item><a class=docs-toc-link href=../../community/roadmap/>Roadmap</a></div></ul></nav></div><div class="d-none d-xl-block col-xl-2 docs-toc"><ul class="nav toc-top"><li><a href=# id=back_to_top class=docs-toc-title>Contents</a></li></ul><nav id=TableOfContents><ul><li><a href=#definition-of-calypso-layer-apis>Definition of Calypso layer APIs</a></li><li><a href=#definition-of-reader-layer-apis>Definition of Reader layer APIs</a><ul><li><a href=#types-of-contributions>Types of contributions</a></li><li><a href=#contributing-via-fork>Contributing via fork</a></li><li><a href=#commits-message-conventions>Commits message conventions</a></li></ul></li></ul></nav></div><main class="col-12 col-md-9 col-xl-8 py-md-3 pl-md-5 docs-content" role=main><div class=docs-article-container></div><div class=docs-article-container><h1>How to contribute</h1><article class=article-style><hr><h2 id=definition-of-calypso-layer-apis>Definition of Calypso layer APIs</h2><p>The <a href=https://calypsonet.org/about-calypso-networks-association-cna/ target=_blank rel=noopener><strong>C</strong>alypso <strong>N</strong>etworks <strong>A</strong>ssociation</a> is responsible for specifying, qualifying and promoting the Calypso ticketing standard. <strong>Contributions to the definition of Calypso APIs for ticketing terminals are therefore reserved for CNA members</strong> participating in the <a href=https://calypsonet.org/working-groups/ target=_blank rel=noopener>“TC Terminal” technical working group</a>.</p><ul><li>Registered members have access to a <a href=https://calypsonet.sharepoint.com/sites/TCterminal/SitePages/Home.aspx target=_blank rel=noopener>document database and a discussion forum</a> to exchange ideas, propose and agree on solutions for the design of interoperable Calypso ticketing terminals.</li><li>These collaborations have, for example, led to the <a href=https://calypsonet.org/document/calypso-layer-requirements-v2-0-200423/ target=_blank rel=noopener>specification of requirements for the Calypso layer of ticketing terminals</a>. Compliance with these requirements by ticketing terminal solutions ensures interoperability with all Calypso card and SAM products.</li></ul><p>Calypso APIs for ticketing terminals:</p><ul><li>enable the implementation of libraries that meet the requirements of the Calypso layer,</li><li>provide a solution for developing ticketing applications for terminals independently of Calypso middleware solutions,</li><li>will soon enable Calypso terminal solutions to certify compliance with Calypso layer requirements.</li></ul><p><a href=https://calypsonet.org/cna-community-overview/ target=_blank rel=noopener>Join CNA</a> to contribute to defining <a href=https://terminal-api.calypsonet.org/specifications/calypso-layer/ target=_blank rel=noopener>Calypso APIs for ticketing terminals</a>.</p><h2 id=definition-of-reader-layer-apis>Definition of Reader layer APIs</h2><p>An interoperable Calypso software layer can only be built on a generic reader software layer interface, independent of card reader solutions and ticketing terminal architecture (embedded/distributed). CNA is not necessarily legitimate in defining such “universal” terminal interfaces for the smart card industry but has initiated these definitions in response to the need for a basis on which to build Calypso APIs.</p><p>For the <a href=https://terminal-api.calypsonet.org/specifications/reader-layer/ target=_blank rel=noopener>definition of the reader APIs for ticketing terminals</a>, CNA is <strong>interested in the participation of any external contributor</strong> and is also open to sharing the governance of this project with other entities or the open-source community. (CNA offered the <a href=https://www.smart-ticketing.org/ target=_blank rel=noopener><strong>S</strong>mart <strong>T</strong>icketing <strong>A</strong>lliance</a> to host this project.
+<span class=sidebar-search-shortcut>/</span></button></form><nav class="collapse docs-links" id=docs-nav><ul class="nav docs-sidenav"><li><a href=../../community/></a></li><div class=docs-toc-item><a class="docs-toc-link active" href=../../community/contributing/>Contributing</a></div><div class=docs-toc-item><a class=docs-toc-link href=../../community/roadmap/>Roadmap</a></div></ul></nav></div><div class="d-none d-xl-block col-xl-2 docs-toc"><ul class="nav toc-top"><li><a href=# id=back_to_top class=docs-toc-title>Contents</a></li></ul><nav id=TableOfContents><ul><li><a href=#project-governance>Project governance</a></li><li><a href=#definition-of-calypso-layer-apis>Definition of Calypso layer APIs</a></li><li><a href=#definition-of-reader-layer-apis>Definition of Reader layer APIs</a><ul><li><a href=#types-of-contributions>Types of contributions</a></li><li><a href=#contributing-via-fork>Contributing via fork</a></li><li><a href=#commits-message-conventions>Commits message conventions</a></li></ul></li></ul></nav></div><main class="col-12 col-md-9 col-xl-8 py-md-3 pl-md-5 docs-content" role=main><div class=docs-article-container></div><div class=docs-article-container><h1>How to contribute</h1><article class=article-style><hr><h2 id=project-governance>Project governance</h2><p><a href=https://calypsonet.org/ target=_blank rel=noopener>CNA</a>&rsquo;s obviously legitimate to lead the definition of software interfaces to manage <a href=https://calypsonet.org/solutions-overview/ target=_blank rel=noopener>Calypso solutions</a>.<br><span style=color:red>Regarding the definition of generic interfaces for the smart card industry, CNA is open to share the driving of this work with any interested organization or manufacturer</span>.</p><h2 id=definition-of-calypso-layer-apis>Definition of Calypso layer APIs</h2><p>The <a href=https://calypsonet.org/about-calypso-networks-association-cna/ target=_blank rel=noopener><strong>C</strong>alypso <strong>N</strong>etworks <strong>A</strong>ssociation</a> is responsible for specifying, qualifying and promoting the Calypso ticketing standard. <strong>Contributions to the definition of Calypso APIs for ticketing terminals are therefore reserved for CNA members</strong> participating in the <a href=https://calypsonet.org/working-groups/ target=_blank rel=noopener>“TC Terminal” technical working group</a>.</p><ul><li>Registered members have access to a <a href=https://calypsonet.sharepoint.com/sites/TCterminal/SitePages/Home.aspx target=_blank rel=noopener>document database and a discussion forum</a> to exchange ideas, propose and agree on solutions for the design of interoperable Calypso ticketing terminals.</li><li>These collaborations have, for example, led to the <a href=https://calypsonet.org/document/calypso-layer-requirements-v2-0-200423/ target=_blank rel=noopener>specification of requirements for the Calypso layer of ticketing terminals</a>. Compliance with these requirements by ticketing terminal solutions ensures interoperability with all Calypso card and SAM products.</li></ul><p>Calypso APIs for ticketing terminals:</p><ul><li>enable the implementation of libraries that meet the requirements of the Calypso layer,</li><li>provide a solution for developing ticketing applications for terminals independently of Calypso middleware solutions,</li><li>will soon enable Calypso terminal solutions to certify compliance with Calypso layer requirements.</li></ul><p><a href=https://calypsonet.org/cna-community-overview/ target=_blank rel=noopener>Join CNA</a> to contribute to defining <a href=https://terminal-api.calypsonet.org/specifications/calypso-layer/ target=_blank rel=noopener>Calypso APIs for ticketing terminals</a>.</p><h2 id=definition-of-reader-layer-apis>Definition of Reader layer APIs</h2><p>An interoperable Calypso software layer can only be built on a generic reader software layer interface, independent of card reader solutions and ticketing terminal architecture (embedded/distributed). CNA is not necessarily legitimate in defining such “universal” terminal interfaces for the smart card industry but has initiated these definitions in response to the need for a basis on which to build Calypso APIs.</p><p>For the <a href=https://terminal-api.calypsonet.org/specifications/reader-layer/ target=_blank rel=noopener>definition of the reader APIs for ticketing terminals</a>, CNA is <strong>interested in the participation of any external contributor</strong> and is also open to sharing the governance of this project with other entities or the open-source community. (CNA offered the <a href=https://www.smart-ticketing.org/ target=_blank rel=noopener><strong>S</strong>mart <strong>T</strong>icketing <strong>A</strong>lliance</a> to host this project.
 Another option currently under consideration is to transfer this responsibility to the <a href=https://keypop.org/ target=_blank rel=noopener>Eclipse Keypop open-source project</a>.)</p><h3 id=types-of-contributions>Types of contributions</h3><p>Thanks for your interest in participating in the reader layer APIs definition for a ticketing terminal.
 There are several ways to contribute to the project:</p><ul><li><strong>Propose a fix</strong> for a problem that is already known or that you have identified. In this case you will have to notify the issue in the repository where the problem appeared and reference the issue in all the other repositories affected by the fix.</li><li><strong>Propose the creation of a new component</strong>: in this case you will first have to create an issue in the repository <a href=https://github.com/calypsonet/calypsonet-terminal-api-website/issues target=_blank rel=noopener>github.com/calypsonet/calypsonet-terminal-api-website</a> to justify the need and request the creation of a new repository, wait for the issue to be resolved by the decision of the committers, and then create an issue in the new repository signifying the start of development of the new component.</li></ul><h3 id=contributing-via-fork>Contributing via fork</h3><ol><li>Check if there is already a GitHub issue for what you want to work on or create one.</li><li>Announce in the comments section that you want to work on the issue. Also describe the solution you want to implement.
 To improve the chances for your contribution to be accepted, you&rsquo;ll want to wait for the feedback of the committers.</li><li>Fork the repository.</li><li>Create a new branch from <code>main</code> for your changes. Name it after the issue number, e.g. <code>#XXX_[description_of_changes]</code>.</li><li>Implement your changes.</li><li>Rebase on <code>main</code>.</li><li>Run <code>./gradlew spotlessApply</code> to format the code and add licence headers to the files.</li><li>Run <code>./gradlew build</code> (to check code formatting and run tests)</li><li>Commit your changes using the <code>-s</code> flag in order to add a <strong>Signed-off-by</strong> footer as mentioned above and use the same email address you are using for your GitHub account.<br>Use commits messages that respect the <a href=#commits-message-conventions>commits message conventions</a>.</li><li>Push your changes to your forked repository.</li><li>Submit a <a href=https://help.github.com/articles/using-pull-requests/ target=_blank rel=noopener>pull request</a> referencing the related issue(s).</li><li>After submitting, do not use your branch for any other development, otherwise further changes that you make will be visible in the PR.</li></ol><h3 id=commits-message-conventions>Commits message conventions</h3><p>In order to ensure good readability of the commit history, it is necessary to have consistency in the structure of the commit messages.</p><p>Therefore, all contributors to the project are asked to respect the structure of the commits messages as described in the guide <a href=https://www.conventionalcommits.org/en/v1.0.0/ target=_blank rel=noopener>Conventional Commits 1.0.0</a>:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-fallback data-lang=fallback><span class=line><span class=cl>&lt;type&gt;[optional scope]: &lt;description&gt;
@@ -21,7 +21,7 @@
 </span></span><span class=line><span class=cl>
 </span></span><span class=line><span class=cl><span class=na>Closes #34, closes #38</span>
 </span></span><span class=line><span class=cl><span class=na>Refs: #12, calypsonet/calypsonet-terminal-reader-uml-api#54</span>
-</span></span></code></pre></div></article><div class=article-widget><div class=post-nav></div></div></div><div class=body-footer><p>Last updated on 2024-09-04</p></div><footer class=site-footer><p class="powered-by copyright-license-text">© 2021-2024 Calypso Networks Association. All Rights Reserved.</p><p class=powered-by id=template-info>Published with <a href="https://hugoblox.com/?utm_campaign=poweredby" target=_blank rel=noopener>Hugo Blox Builder</a> — the free, <a href=https://github.com/HugoBlox/hugo-blox-builder target=_blank rel=noopener>open source</a> website builder that empowers creators.</p></footer></main></div></div></div><div class=page-footer></div><script src=../../js/vendor-bundle.min.938a3a7554cd9f6602290411f64d2617.js></script><script src=https://cdn.jsdelivr.net/npm/[email protected]/dist/leaflet.min.js integrity crossorigin=anonymous></script><script src=https://cdn.jsdelivr.net/npm/[email protected]/anchor.min.js integrity="sha256-aQmOEF2ZD4NM/xt4hthzREIo/2PFkOX/g01WjxEV7Ys=" crossorigin=anonymous></script><script>anchors.add()</script><script id=search-hit-fuse-template type=text/x-template>
+</span></span></code></pre></div></article><div class=article-widget><div class=post-nav></div></div></div><div class=body-footer><p>Last updated on 2024-11-06</p></div><footer class=site-footer><p class="powered-by copyright-license-text">© 2021-2024 Calypso Networks Association. All Rights Reserved.</p><p class=powered-by id=template-info>Published with <a href="https://hugoblox.com/?utm_campaign=poweredby" target=_blank rel=noopener>Hugo Blox Builder</a> — the free, <a href=https://github.com/HugoBlox/hugo-blox-builder target=_blank rel=noopener>open source</a> website builder that empowers creators.</p></footer></main></div></div></div><div class=page-footer></div><script src=../../js/vendor-bundle.min.938a3a7554cd9f6602290411f64d2617.js></script><script src=https://cdn.jsdelivr.net/npm/[email protected]/dist/leaflet.min.js integrity crossorigin=anonymous></script><script src=https://cdn.jsdelivr.net/npm/[email protected]/anchor.min.js integrity="sha256-aQmOEF2ZD4NM/xt4hthzREIo/2PFkOX/g01WjxEV7Ys=" crossorigin=anonymous></script><script>anchors.add()</script><script id=search-hit-fuse-template type=text/x-template>
     <div class="search-hit" id="summary-{{key}}">
       <div class="search-hit-content">
         <div class="search-hit-name">