<!-- 
RSS generated by JIRA (1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d) at Thu Feb 08 23:19:11 UTC 2024

It is possible to restrict the fields that are returned in this document by specifying the 'field' parameter in your request.
For example, to request only the issue key and summary add field=key&field=summary to the URL of your request.
-->
<rss version="0.92" >
<channel>
    <title>FOLIO Jira</title>
    <link>https://folio-org.atlassian.net</link>
    <description>This file is an XML representation of an issue</description>
    <language>en-us</language>    <build-info>
        <version>1001.0.0-SNAPSHOT</version>
        <build-number>100246</build-number>
        <build-date>07-02-2024</build-date>
    </build-info>

<item>
            <title>[FOLIO-2232] Spike: Gather existing guidelines for version numbers, naming conventions, etc.</title>
                <link>https://folio-org.atlassian.net/browse/FOLIO-2232</link>
                <project id="10290" key="FOLIO">FOLIO</project>
                    <description>&lt;p&gt;We need to clearly document instructions about when to change numbers relating to interfaces and implementations, and for various naming conventions.&lt;/p&gt;

&lt;p&gt;Use this ticket to gather existing instructions.&lt;/p&gt;

&lt;p&gt;Then we can decide whether to expand those documents, consolidate, or to create additional summary documents, etc.&lt;/p&gt;</description>
                <environment></environment>
        <key id="81425">FOLIO-2232</key>
            <summary>Spike: Gather existing guidelines for version numbers, naming conventions, etc.</summary>
                <type id="10003" iconUrl="https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10318?size=medium">Task</type>
                                            <priority id="10005" iconUrl="https://dev.folio.org/assets/jira-priority/tbd.svg">TBD</priority>
                        <status id="6" iconUrl="https://folio-org.atlassian.net/images/icons/statuses/closed.png" description="The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.">Closed</status>
                    <statusCategory id="3" key="done" colorName="green"/>
                                    <resolution id="10003">Done</resolution>
                                                        <assignee accountid="61cd0ca0bce5e00069e98be7">David Crossley</assignee>
                                                                <reporter accountid="61cd0ca0bce5e00069e98be7">David Crossley</reporter>
                                    <labels>
                            <label>devdoc</label>
                            <label>platform-backlog</label>
                    </labels>
                <created>Thu, 29 Aug 2019 06:51:39 +0000</created>
                <updated>Wed, 3 Jun 2020 16:40:05 +0000</updated>
                            <resolved>Fri, 30 Aug 2019 03:27:19 +0000</resolved>
                                                                        <due></due>
                            <votes>0</votes>
                                    <watches>2</watches>
                                                                <comments>
                                                            <comment id="192853" author="61cd0ca0bce5e00069e98be7" created="Thu, 29 Aug 2019 07:02:34 +0000"  >&lt;p&gt;&lt;b&gt;Interface compatibility&lt;/b&gt; (when is a change interface breaking)&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://dev.folio.org/guidelines/contributing/#apiinterface-versions&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://dev.folio.org/guidelines/contributing/#apiinterface-versions&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;&lt;b&gt;Implementation compatibility&lt;/b&gt; (when is a change implementation breaking)&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://dev.folio.org/guidelines/contributing/#implementation-versions&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://dev.folio.org/guidelines/contributing/#implementation-versions&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;&lt;b&gt;Interface version numbers&lt;/b&gt; (when and how should interface versions change)&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://dev.folio.org/guidelines/contributing/#version-numbers&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://dev.folio.org/guidelines/contributing/#version-numbers&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://dev.folio.org/guidelines/contributing/#apiinterface-versions&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://dev.folio.org/guidelines/contributing/#apiinterface-versions&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://dev.folio.org/guidelines/naming-conventions/#interfaces&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://dev.folio.org/guidelines/naming-conventions/#interfaces&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;&lt;b&gt;Implementation version numbers&lt;/b&gt; (when and how should implementation versions change)&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://dev.folio.org/guidelines/contributing/#version-numbers&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://dev.folio.org/guidelines/contributing/#version-numbers&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://dev.folio.org/guidelines/contributing/#implementation-versions&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://dev.folio.org/guidelines/contributing/#implementation-versions&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;&lt;b&gt;API standards and conventions&lt;/b&gt; (e.g. endpoint paths and naming, JSON schema naming, structure etc)&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://dev.folio.org/guidelines/contributing/#naming-conventions&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://dev.folio.org/guidelines/contributing/#naming-conventions&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://dev.folio.org/guidelines/naming-conventions/&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://dev.folio.org/guidelines/naming-conventions/&lt;/a&gt;&lt;br/&gt;
which also has conventions for interface names, module names, permissions&lt;/p&gt;

&lt;p&gt;&lt;b&gt;Release numbers and release branch names&lt;/b&gt;&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://dev.folio.org/guidelines/naming-conventions/#release-branches-and-tags&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://dev.folio.org/guidelines/naming-conventions/#release-branches-and-tags&lt;/a&gt;&lt;br/&gt;
which also links to further information for front-end and back-end &quot;release procedures&quot;&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://dev.folio.org/guidelines/release-procedures/#prepare-and-perform-the-source-release&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://dev.folio.org/guidelines/release-procedures/#prepare-and-perform-the-source-release&lt;/a&gt;&lt;br/&gt;
also discusses &quot;the release tag/version, the next post-release SNAPSHOT version&quot;&lt;/p&gt;</comment>
                                                            <comment id="192858" author="63e2a2771b13d42998e4e706" created="Fri, 8 May 2020 11:19:22 +0000"  >&lt;p&gt;&lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=61cd0ca0bce5e00069e98be7&quot; class=&quot;user-hover&quot; rel=&quot;61cd0ca0bce5e00069e98be7&quot; data-account-id=&quot;61cd0ca0bce5e00069e98be7&quot; accountid=&quot;61cd0ca0bce5e00069e98be7&quot; rel=&quot;noreferrer&quot;&gt;David Crossley&lt;/a&gt; Thank you for doing this (I know it was ages ago :-/ )&lt;/p&gt;

&lt;p&gt;I&apos;ve had this on my to-do list for ages, and I&apos;m not managing to get around to it, but wanted to say thank you anyway.&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10003">
                    <name>Relates</name>
                                                                <inwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="81289">FOLIO-2214</issuekey>
        </issuelink>
                            </inwardlinks>
                                    </issuelinktype>
                    </issuelinks>
                <attachments>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                <customfield id="customfield_10000" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummarycf">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10057" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
                        <customfieldname>Development Team</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="10144"><![CDATA[Core: Platform]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_10019" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>0|i002nb:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10020" key="com.pyxis.greenhopper.jira:gh-sprint">
                        <customfieldname>Sprint</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue id="1468">CP: sprint 71</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                            <customfield id="customfield_10044" key="com.atlassian.jira.plugin.system.customfieldtypes:float">
                        <customfieldname>Story Points</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                <customfield id="customfield_10024" key="com.atlassian.jira.ext.charting:firstresponsedate">
                        <customfieldname>[CHART] Date of First Response</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>Fri, 8 May 2020 11:19:22 +0000</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10025" key="com.atlassian.jira.ext.charting:timeinstatus">
                        <customfieldname>[CHART] Time in Status</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                    </customfields>
    </item>
</channel>
</rss>