Contributing to Sitecore Shared Source Projects

The current edition of this post is at:

http://www.sitecore.net/Community/Technical-Blogs/John-West-Sitecore-Blog/Posts/2010/11/Contributing-to-Sitecore-Shared-Source-Projects.aspx

The following tips for working with Sitecore shared source are based on my recent experience contributing the FieldValueComparer (based on to the comparer in this post) to the Sitecore Shared Source project.

  • Review this introduction to contributing shared source to obtain access to Subversion or to request a new project room.
  • Each project room is basically a Wiki. The only way back to the list of project rooms seems to be http://trac.sitecore.net/Index, so most project rooms include this link.
  • Review this guide to contributing shared source.
  • Copy files into the Trunk directory and check them in.
  • I don’t like learning a new markup, but when editing the Wiki:
    • It seems to format linefeeds as HTML paragraphs or line breaks.
    • Use equals signs for major headings (the spacing seems to be important): 
      = heading =
      
    • Use more equals signs for minor headings:
      == heading ==
      
    • Preceed text with an exclamation mark to avoid the Wiki automatically creating a link:
      = Welcome to the !ProjectRoomName =
      
    • Wrap URLs with quare brackets, optionally followed by a space and the text of the link:
      [http://sitecore.net Sitecore Marketing Site]
      
    • Wrap code with three curly braces to preformat it for easy copy and paste:
      {{{
      // code
      }}}
      
    • You can create entries in numbered lists by entering a space character, a number, and a period on a blank line:
       1. First.
       2. Second.
      
  • Please report issues and feature requests for shared source components by posting on the Shared Source Modules forum on the Sitecore Developer Network.

I will try to maintain this list and the FieldValueComparer project room as a template for cutting and pasting when creating new projects.

Update: Shared source projects use the Sitecore.Sharedsource top-level namespace. The Sitecore Shared Source Coordinator provided me with the URL of a Wiki formatting cheat sheet: http://trac.edgewall.org/wiki/WikiFormatting.

This entry was posted in Obsolete. Bookmark the permalink.

Leave a comment