Contributing code back to OpenACS

Prev	Chapter�14.� CVS Guidelines -	Next

There are three main ways to contribute code to OpenACS:

To contribute a small fix, if you do not have a developer account, submit a patch.
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
```
  + Next
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:
  Use one of the checkout methods described above to get files to your system. This takes the place of steps 1 and 2 in Section�, “Installation Option 2: Install from tarball”. Continue setting up the site as described there.
  Fix bugs and add features.
  + 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 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. @@ -14,16 +15,16 @@
3. Add a new package. Contact the Core Team to get approval and to get a module alias created.
  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 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 newpackage-0-1d
  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 +cvs import -m "Initial import of newpackage" openacs-4/packages/newpackage myname newpackage-0-1d
  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�.
  +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
  new�revision:�1.94;�previous�revision:�1.93
  done
  cvs�commit:�Rebuilding�administrative�file�database
  Although you should add your package on HEAD, you should do package development on the latest release branch that your code is compatible with. So, after completing the import, you may want to branch your package:
  cd /var/lib/aolserver/service0/packages/newpackage -cvs tag -b oacs-5-1
  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:
  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 rm. One approach for file in `find | grep -v CVS`; do rm $file; cvs remove $file; done
+cvs tag -b oacs-5-1
See Section�, “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:

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 rm. One approach for file in `find | grep -v CVS`; do rm $file; cvs remove $file; done

Contributing code back to OpenACS

Contributing code back to OpenACS

Note

+cvs tag -b oacs-5-1

Note

Rules for Committing Code to the OpenACS repository

+

Reasons

+

Informal Guidelines