Be careful with theses rules since they are not only for xwiki-platform but also for contrib application and it should be made clear that this is only for an application that require 7.2 or more which is really not a good idea for a new contrib extension.
On Sun, Sep 27, 2015 at 9:19 PM, vinc...@massol.net <vinc...@massol.net> wrote: > Hi devs, > > Following our implementation of NS/NP in 7.2 I’d like to propose 2 new best > practices for app dev that we would list at > http://dev.xwiki.org/xwiki/bin/view/Community/ApplicationDevelopmentBestPractices > > 1) New rule 1: “Code” subspace > > Current text: > * Generally, put all your pages in a single space dedicated for the > application you're developing (e.g. Faq, Scheduler, IRC, AppWithinMinutes, > etc). The name must be as short as possible while still being understandable > of course and without overusing abbreviations. > > New version: > * Generally, put all your pages in a single space dedicated for the > application you're developing (e.g. Faq, Scheduler, IRC, AppWithinMinutes, > etc). The name must be as short as possible while still being understandable > of course and without overusing abbreviations. > * Technical pages should be put in a subspace named “Code” > > Note: this rule can only be applied for new applications for now since the EM > doesn’t know how to follow renames currently so for example if I move pages > from the FAQCode space to the FAQ.Code space, when EM upgrades the app, it’ll > display all pages in FAQCode as deleted (basically it considers all pages in > FAQ.Code as new pages and pages in FAQCode as deleted pages). Note: I’ve > created http://jira.xwiki.org/browse/XWIKI-12622 for this. > > 2) New rule 2: > > * Technical pages without children must be terminal pages. > > WDYT? > > Thanks > -Vincent > > > _______________________________________________ > devs mailing list > devs@xwiki.org > http://lists.xwiki.org/mailman/listinfo/devs -- Thomas Mortagne _______________________________________________ devs mailing list devs@xwiki.org http://lists.xwiki.org/mailman/listinfo/devs
