Changes for page XWiki Contrib

Last modified by Vincent Massol on 2024/04/11 10:44

From version 135.1
edited by Vincent Massol
on 2023/04/25 14:06
Change comment: There is no comment for this version
To version 136.1
edited by Vincent Massol
on 2023/05/16 14:01
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -46,6 +46,24 @@
46 46  
47 47  == Choosing the name ==
48 48  
49 +When picking the GitHub name please use a single word (e.g. ##forum##). However, sometimes that is not descriptive enough, so you can either use multiple words next to each other (e.g. ##filemanager##) if that makes sense and looks natural enough or, if not, you should separate the words with a dash (e.g. ##multiselect-suggest##). Whatever you decide, please try to keep it as short and descriptive as possible.
50 +
51 +Try to avoid using names that would not work well if some new Maven modules need to be added in the future (e.g. avoid using ##figure-macro## since there could be new modules added that wouldn't be macros, such as API, Application (XAR) or other module types. In short, this means having a "business" name, not related to the extension type.
52 +
53 +If there's already a repo with the name you want to use, consider adding your code as a sub-module if it fits the same domain and can be released together (same release lifecycle). If it doesn't fit, use a different name (adding a qualifier or a different name altogether).
54 +
55 +Special cases:
56 +
57 +* ##icon-themes##. This is a reserved name and it's also the name of a [[special repository containing all Icon Themes>>https://github.com/xwiki-contrib/icon-themes]]. If you want to contribute a new Icon theme, you should add a new ##icon-theme-<yyy>## directory in this repository. We release all Icon Themes together with the same version as we consider them too small to be released separately.
58 +* ##color-themes##. This is a reserved name and it's also the name of a [[special repository containing all Color Themes>>https://github.com/xwiki-contrib/color-themes]]. If you want to contribute a new Color theme, you should add a new ##color-theme-<yyy>## directory in this repository. We release all Color Themes together with the same version as we consider them too small to be released separately.
59 +
60 +//Hint//: When in doubt, have a look at [[existing repository names>>https://github.com/xwiki-contrib]] for inspiration but only for repos created after the 2023-05-16 since the naming strategy was changed at that date!
61 +
62 +Always avoid using the ##xwiki-## prefix since this one is used by XWiki GitHub organization repositories (i.e. Core modules). You should also avoid using it as a suffix since all Contrib projects are related to XWiki.
63 +
64 +{{info}}
65 +Before the 16th of May 2023, the rules were:
66 +
49 49  When picking the GitHub name please follow the existing conventions:
50 50  
51 51  * ##application-<xxx>## for apps
... ... @@ -67,6 +67,7 @@
67 67  //Hint//: When in doubt, have a look at [[existing repository names>>https://github.com/xwiki-contrib]] for inspiration.
68 68  
69 69  Please try to avoid using the ##xwiki-## prefix since this one is used by XWiki GitHub organization repositories (i.e. Core modules).
88 +{{/info}}
70 70  
71 71  == README.md Template ==
72 72  

Get Connected