Changes for page XWiki Contrib
Last modified by Vincent Massol on 2024/03/11 10:26
Change comment:
Clarifications on choosing a project name.
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -46,6 +46,10 @@ 46 46 * ##api-<xxx>## for APIs only (same as for macro, if it contains UI as well, then you should call it an app instead) 47 47 * ##displayer-<xxx>## for custom displayers 48 48 49 +For the actual project name part (##<xxx>## of the git repository name) it is preferred to use a single word (e.g. ##applicatin-forum##). However, sometimes that is not descriptive enough, so you can either use multiple words next to eachother (e.g. ##application-filemanager##) if that makes sense and looks natural enough or, if not, you should separate the words with a dash (e.g. ##displayer-multiselect-suggest##). Whatever you decide, please try to keep it as short and descriptive as possible. 50 + 51 +Hint: If in doubt, have a look at [[existing repository names>>https://github.com/xwiki-contrib]] for inspiration. 52 + 49 49 = Requesting snapshot builds for your project = 50 50 51 51 XWiki.org has a [[continuous build>>http://dev.xwiki.org/xwiki/bin/view/Community/ContinuousBuild]] which builds maven projects each time they are modified on GitHub and put the resulting artifact in our [[snapshots repository>>http://maven.xwiki.org/snapshots/]]. This is useful when you want people using your project as a dependency to continuously benefit from the improvements.