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 -r1.1.2.2 -r1.1.2.3 --- openacs-4/packages/acs-core-docs/www/contributing-code.html 8 Nov 2004 19:59:05 -0000 1.1.2.2 +++ openacs-4/packages/acs-core-docs/www/contributing-code.html 27 Nov 2004 01:32:48 -0000 1.1.2.3 @@ -6,15 +6,15 @@ Commit that file (or files): 

cvs commit -m "what I did and why" filename

Because this occurs in your personal checkout and not an anonymous one, this commit automagically moves back upstream to the Mother - Ship repository at openacs.org. The names of the changed files, and your comments, are sent to a mailing list for OpenACS developers. A Core Team developer may review or roll back your changes if necessary. + Ship repository at cvs.openacs.org. The names of the changed files, and your comments, are sent to a mailing list for OpenACS developers. A Core Team developer may review or roll back your changes if necessary.

  • Confirm via the OpenACS CVS browser 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: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 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:openacs.org:/cvsroot co CVSROOT
+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 import -m "Initial import of newpackage" openacs-4/packages/newpackage myname 0.1d

    3. 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�.
      ****�Access�allowed:�Personal�Karma�exceeds�Environmental�Karma.
      @@ -23,7 +23,7 @@ new�revision:�1.94;�previous�revision:�1.93
      done
      cvs�commit:�Rebuilding�administrative�file�database

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

    • - Rules for Committing Code to the OpenACS.org repository + Rules for Committing Code to the OpenACS repository

    CVS commit procedures are governed by @@ -59,7 +59,7 @@ Code

    1. Only GPL code and material should be committed to the - openacs.org CVS repository + OpenACS CVS repository (cvs.openacs.org)

    2. Code should only be reformatted when functionality is changed, e.g. when you change control flow and reindent to reflect @@ -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: