From 72fa303e37e7fd15594e942906adfb3db051fecd Mon Sep 17 00:00:00 2001 From: Adam Samalik Date: Apr 25 2019 09:05:53 +0000 Subject: clarify using of upstream naming conventions --- diff --git a/modules/ROOT/pages/making-modules/naming-guidelines.adoc b/modules/ROOT/pages/making-modules/naming-guidelines.adoc index 1d602ab..b4b406a 100644 --- a/modules/ROOT/pages/making-modules/naming-guidelines.adoc +++ b/modules/ROOT/pages/making-modules/naming-guidelines.adoc @@ -27,15 +27,21 @@ If your module is a "collection of items" with no primary piece of software (e.g === Option 3: Rolling and unstable streams -For streams that don't guarantee an API/ABI stability over time and just roll forward, we suggest packagers use one of the following stream names. However, using other names that are well-established upstream is also a good option. +For streams that don't guarantee an API/ABI stability over time and just roll forward, we suggest packagers use one of the following stream names. * "rolling" for user-focused content meant for general use * "unstable" for pre-release content or content in active development meant for preview and testing rather than general use -In whatever case, we mandate a good use of the description and/or summary field to clearly state what this particular stream represents. +We mandate a good use of the description and/or summary field to clearly state what this particular stream represents. This policy doesn't enforce changes in existing branch names, however, packagers are welcome to do so in order to bring more consistency to the distribution. +=== Option 4: Upstream conventions + +In case there are well-established upstream conventions, using them is also a good option. + +Again, especially in this case, we mandate a good use of the description and/or summary field to clearly state what this particular stream represents. + == Module profile name and description Profiles make installation easier by giving the user some predefined package groups that represent a common installation for a specific use case. Profiles have name and a description — using both is mandatory.