Contributing code back to OpenACS

Chapter�13.� + ">

Prev	Chapter�14.� CVS Guidelines	Next

Contributing code back to OpenACS

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
```
  @@ -14,7 +14,7 @@
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 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
+cvs import -m "Initial import of newpackage" openacs-4/packages/newpackage myname newpackage-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.
  @@ -122,7 +122,7 @@ Tags
  When a package is released in final form, the developer - shall tag it "packagename-x-y-z-final" and "oacs-x-y-compat". x-y + shall tag it "packagename-x-y-z-final" and "openacs-x-y-compat". x-y should correspond to the current branch. If the package is compatible with several different core versions, several compat tags should be applied. @@ -135,7 +135,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 @@ -171,7 +171,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:

Contributing code back to OpenACS

+

Reasons

+

Informal Guidelines