Index: openacs-4/packages/acs-core-docs/www/contributing-code.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/Attic/contributing-code.html,v diff -u -N -r1.1.2.3 -r1.1.2.4 --- openacs-4/packages/acs-core-docs/www/contributing-code.html 27 Nov 2004 01:32:48 -0000 1.1.2.3 +++ openacs-4/packages/acs-core-docs/www/contributing-code.html 30 Nov 2004 20:58:41 -0000 1.1.2.4 @@ -13,7 +13,7 @@ that your changes are where you intended them to be.

  • Add a new package. Contact the Core Team to get approval and to get a module alias created.

    1. Check out acs-core on the HEAD branch. (Weird things happen if you add files to a branch but not to HEAD):

      cd /tmp
-cvs -d:ext:cvs.openacs.org:/cvsroot checkout acs-core

      Copy your package directory from your working directory to this directory. Make sure not to copy any CVSROOT directories.

      cp /var/lib/aolserver/service0/packagse/newpackage /tmp/openacs-4/packages

      Import the package into the cvs.openacs.org cvs repository:

      cd /tmp/openacs-4/packages/newpackage
+cvs -d:ext:cvs.openacs.org:/cvsroot checkout acs-core

      Copy your package directory from your working directory to this directory. Make sure not to copy any CVS directories.

      cp -r /var/lib/aolserver/service0/packages/newpackage /tmp/openacs-4/packages

      Import the package into the cvs.openacs.org cvs repository:

      cd /tmp/openacs-4/packages/newpackage
 cvs import -m "Initial import of newpackage" openacs-4/packages/newpackage myname 0.1d

    2. Add the new package to the modules file. (An administrator has to do this step.) On any machine, in a temporary directory:

      cvs -d :ext:cvs.openacs.org:/cvsroot co CVSROOT
 cd CVSROOT
 emacs modules

      Add a line of the form:

      photo-album-portlet openacs-4/packages/photo-album-portlet

      Commit the change:

      cvs commit -m "added alias for package newpackage" modules

      This should print something like:

      cvs�commit:�Examining�.
      @@ -22,7 +22,7 @@ /cvsroot/CVSROOT/modules,v��<--��modules
      new�revision:�1.94;�previous�revision:�1.93
      done
      -cvs�commit:�Rebuilding�administrative�file�database

    3. See the section called “How to package and release an OpenACS Package”

    • +cvs�commit:�Rebuilding�administrative�file�database

  • See the section called “How to package and release an OpenACS Package”

    • Note

    Some packages are already in cvs at openacs-4/contrib/packages. Starting with OpenACS 5.1, we have a Maturity mechanism in the APM which makes the contrib directory un-necessary. If you are working on a contrib package, you should move it to /packages. This must be done by an OpenACS administrator. On cvs.openacs.org:

    1. cp -r /cvsroot/openacs-4/contrib/packages/package0 /cvsroot/openacs-4/packages

    2. Update the modules file as described above.

    3. Remove the directory from cvs in the old location using cvs remove.

    Rules for Committing Code to the OpenACS repository

    CVS commit procedures are governed by @@ -134,7 +134,7 @@ flag which defaults to no-effect wouldn't require a TIP. Added a new mandatory flag to an existing function would require a TIP. -

    +

    Reasons

    We don't currently have clear standards for committing @@ -170,7 +170,7 @@ applies to all packages. This tag can be used to fork packages as needed, and provides a common ancestor between the fork and the OpenACS code so that patches can be generated. -

    +

    Informal Guidelines

    Informal guidelines which may be obsolete in places and should be reviewed: Index: openacs-4/packages/acs-core-docs/www/xml/engineering-standards/cvs.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/engineering-standards/cvs.xml,v diff -u -N -r1.1.2.4 -r1.1.2.5 --- openacs-4/packages/acs-core-docs/www/xml/engineering-standards/cvs.xml 16 Nov 2004 17:09:38 -0000 1.1.2.4 +++ openacs-4/packages/acs-core-docs/www/xml/engineering-standards/cvs.xml 30 Nov 2004 20:58:38 -0000 1.1.2.5 @@ -326,8 +326,8 @@ Check out acs-core on the HEAD branch. (Weird things happen if you add files to a branch but not to HEAD): cd /tmp cvs -d:ext:cvs.openacs.org:/cvsroot checkout acs-core - Copy your package directory from your working directory to this directory. Make sure not to copy any CVSROOT directories. - cp /var/lib/aolserver/service0/packagse/newpackage /tmp/openacs-4/packages + Copy your package directory from your working directory to this directory. Make sure not to copy any CVS directories. + cp -r /var/lib/aolserver/service0/packages/newpackage /tmp/openacs-4/packages Import the package into the cvs.openacs.org cvs repository: cd /tmp/openacs-4/packages/newpackage cvs import -m "Initial import of newpackage" openacs-4/packages/newpackage myname 0.1d @@ -354,7 +354,20 @@ See - + + Some packages are already in cvs at openacs-4/contrib/packages. Starting with OpenACS 5.1, we have a Maturity mechanism in the APM which makes the contrib directory un-necessary. If you are working on a contrib package, you should move it to /packages. This must be done by an OpenACS administrator. On cvs.openacs.org: + + + cp -r /cvsroot/openacs-4/contrib/packages/package0 /cvsroot/openacs-4/packages + + + Update the modules file as described above. + + + Remove the directory from cvs in the old location using cvs remove. + + +