This Bugzilla instance is deprecated, and most Eclipse projects now use GitHub or Eclipse GitLab. Please see the deprecation plan for details.
Bug 211206 - Create SVN location and guidelines for the development and maintenance of Examples
Summary: Create SVN location and guidelines for the development and maintenance of Exa...
Status: ASSIGNED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: Eclipselink (show other bugs)
Version: unspecified   Edit
Hardware: All All
: P5 normal (vote)
Target Milestone: ---   Edit
Assignee: Nobody - feel free to take it CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks: 239637 337037 239629 239630 239631 249541 309981
  Show dependency tree
 
Reported: 2007-11-28 08:00 EST by Doug Clarke CLA
Modified: 2022-06-09 10:27 EDT (History)
3 users (show)

See Also:
michael.f.obrien: documentation+


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Doug Clarke CLA 2007-11-28 08:00:28 EST
 
Comment 1 Doug Clarke CLA 2008-02-05 13:43:12 EST
Examples will be stored in a hierarchical structure within the given development branch like:

\trunk\examples\jpa\employee\eclipselink.examples.jpa.employee.xml

Note that the leaf folder name should correspond to the Eclipse Java/PDE project name starting with eclipselink.examples. The remainder of the project name should indicate the physical folder hierarchy as well as provide a logical categorization to identify the purpose of the example or the feature being shown.
Comment 2 Shaun Smith CLA 2008-02-07 09:56:55 EST
If we're planning on moving to OSGi centric PDE based development we should consider our project naming convention carefully.  In the OSGi proof of concept I renamed all the projects (but not SVN folders to simplify diffing against MAIN) to the reverse domain structure, e.g., 

   org.eclipse.persistence.jpa
   org.eclipse.persistence.moxy

While this naming convention is not mandatory, it is considered "good form".

I suggest we name all example projects "org.eclipse.persistence.example.*" so the proposed employee example would be:

   org.eclipse.persistence.example.jpa.employee.xml

Note "example" is singular.  I agree we can place all examples under "\trunk\examples\" so they can be versioned and tagged with the rest of the trunk.

For examples of PDE project/bundle naming, open the "Plug-in Development" Perspective in the Eclipse IDE and select the "Plug-ins" view.  All of the plugins you will find follow this naming convention.   
Comment 3 Michael OBrien CLA 2008-07-04 10:39:44 EDT
We need to add Wiki guidelines for examples.  
- All example projects should have a Wiki URL.
- Need to differentiate between examples, tutorials and how-tos.
- Examples have checked-in SVN code (we need to watch that wiki-pasted code does not diverge from the SVN version).
- Tutorials only have wiki-pasted or (downloadable Zip) code.
- General sections on changing hardcoded db and pu parameters, creating the schema, populating the db, test case run order and db cleanup (in the case we dont drop tables and get a constraint violation on a rerun)
Comment 4 Tom Ware CLA 2009-04-16 11:04:27 EDT
Updating priority due to revised bug categorization process.  See the following page for details:

http://wiki.eclipse.org/EclipseLink/Development/Bugs/Guidelines#Priority_and_Target_Milestone 

If you feel the updated priority is incorrect, please send an email to eclipselink-users@eclipse.org.
Comment 5 Michael OBrien CLA 2011-02-18 22:28:07 EST
>Note: directories - bin (SE) and build/classes (EJB/WAR) should not be checked into SVN
>DDL generation can be left 1-time enabled for Derby (DDL scripts do not need to be supplied)
Comment 6 Eclipse Webmaster CLA 2022-06-09 10:27:54 EDT
The Eclipselink project has moved to Github: https://github.com/eclipse-ee4j/eclipselink