Welcome to the Example Project

The example project should offer you some guidelines on how Sitecore would recommend that developers package together their module, so that it is easy to maintain and easier to contribute to when you separate the items in a folder for itself.

Under the Browse Source / Trunk you can see how the structure of the package could look like when using the best practise method to create a Shared Source package. In the data/package folder we have the two zip files ExampleProject and ExampleProjectWithoutSources with their following XML files that developers also have easy access to when wanting to change the package.

Under the two following menues I will be describing how to create the package with the items only and then how to create the zip file that includes the package without sources.

Items only Illustrates how the items only package is created.

Without Sources Illustrates how the package without sources is created and ready for use.

Module that already include the Sitecore best practise is the RSS module and Task Manager. If you want to draw inspiration from that instead.

This was just a description on how to create the package with the Sitecore best practise, the following is a short list of thing that you might want to consider adding to your project room, such as how it is used and what you need to do in order to install the package.

Also if you have an idea on how to already extend the module but just haven't gotten around to do it yourself, you could list some possible ways that contributors that want to help can take on one of these added features.

If you haven't worked with subversion and Trac, you can start out with reading the documentation on SDN in the shared source section under the "Do you want to contribute"

For using SVN on Trac we recommend to start with the structure Trunk, Tags and Branches. Where the Trunk contains the working source code,

the branches folder is for when developing on the project use a branch to work on new features. The Tags folder should be used to store version of the module.

Enjoy!
The Shared Source Coordinator

Starting Points

•  How to contribute -- The starting point of how to get started with contributing.
•  How to build the source code in Sitecore -- Back to the steps of how the steps in creating a package where.

For a complete list of local wiki pages, see TitleIndex.