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.1 -r1.1.2.2 --- openacs-4/packages/acs-core-docs/www/contributing-code.html 3 Nov 2004 16:37:48 -0000 1.1.2.1 +++ openacs-4/packages/acs-core-docs/www/contributing-code.html 8 Nov 2004 19:59:05 -0000 1.1.2.2 @@ -3,7 +3,7 @@ ">

Contributing code back to OpenACS

There are three main ways to contribute code to OpenACS:

  1. To contribute a small fix, if you do not have a developer account, submit a patch.

  2. If you are making many changes, or would like to become a direct contributor, send mail to the Core Team asking for commit rights. You can then commit code directly to the repository:

    1. Use one of the checkout methods described above to get files to your system. This takes the place of steps 1 and 2 in the section called “Installation Option 2: Install from tarball”. Continue setting up the site as described there.

    2. Fix bugs and add features.

    3. - Commit that file (or files):

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

      + 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. @@ -12,11 +12,11 @@ OpenACS CVS browser that your changes are where you intended them to be.

  3. 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
      +                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
    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: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�.
      +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.
      Checking�in�modules;
      /cvsroot/CVSROOT/modules,v��<--��modules
      @@ -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: