[Scribia-dev] CVS comitting

[Lark <lar...@un...>]

A few people asked me to hint on when to commit their local changes to the
remote CVS repository. Here's what I've pulled from various earlier posts o=
n
the topic, FYI:

-----------
If you're unsure, feel free to ask me before committing. Try to commit
increments that work, i.e. don't go off for a half year with today's source=
s
and then do a huge commit. But don't commit things that crash (or don't eve=
n
compile), it pisses people off when they sync their tree and nothing works
anymore. :-)

-----------
> Hi Scribia developers! So what's the next step? I've subscribed to the ma=
iling
> list so now what? Do I register as a new user on the sourceforge site?

Depends. If you just want to grab the source and compile it, you can get it
via anonymous CVS, without the need to register with sourceforge.

If you'd like to actively develop Scribia (i.e. make larger code changes
you'd like to contribute back to me/us) I will add you as a developer. For
that, you will need to do these steps:

1. sign up with sourceforge

2. tell me your sourceforge user name, so I can add you as a developer

****IMPORTANT****
3. open a customer service item with sourceforge, and ask them to set up CV=
S
   "pserver" access to the scribia CVS repository (SSH does not work on the
   Mac)
****IMPORTANT****

After that, you have read/write access to the CVS repository.

Since I don't know if people have used CVS before, here are some short
things you should know:

=80 commit log entries are your friend, please take the time to describe
  changes made to the code

=80 never check in code that has known bugs, or worse, does not compile
  (people will get angry if they'll have to fix your bugs after they have
  CVS updated your changes)

=80 try to use the indentation style of the rest of the sources for new
  things/changes (I've tried to stick to the "Mac way" of indentation and
  naming things as much as I could figure it out; it's not perfect)

=80 include the HEADER file (Documentation folder) at the top of each new
  source file, it has some magic CVS tags in it that auto-insert the commit
  log, current version, etc. (it also has the disclaimer)

--=20
Lark <lar...@un...>