README.developers 2.1 KB
Newer Older
Pekka Pessi's avatar
Pekka Pessi committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
===============================================================
README.developers - Sofia-SIP development practises
===============================================================

Introduction
---------------------------------------------------------------

This file is a collection of practices and rules for Sofia-SIP
development. If you have questions, or would like to make 
changes, raise the issue on sofia-sip-devel (see 
http://lists.sourceforge.net/lists/listinfo/sofia-sip-devel ).


Important files for developers
---------------------------------------------------------------

AUTHORS
	List of contributors. When contributing new code, add 
	yourself to AUTHORS, and also remember to update the
	per source file copyright statements.
	
README.developers 
	This file.

TODO (XXX: to be added)
	Not in active use yet.

*/ChangeLog files
	All non-trivial changes to the source code should
	be documented in the ChangeLog files.


Version numbering 
---------------------------------------------------------------

Package version
~~~~~~~~~~~~~~~

For public releases, the package version is:
     vMAJOR.MINOR.REVISION

XXX: Policy for updating the version.

For development releases the version is:
     vMAJOR.MINOR.REVISION.YEAR.MONTH.DAY 

The development version should be changed in configure.ac 
before making snapshot releases. The person doing the release is 
responsible for updating the version number.


Library interface versions
~~~~~~~~~~~~~~~~~~~~~~~~~~

TBD


Sending patches
---------------------------------------------------------------

People without CVS-access
~~~~~~~~~~~~~~~~~~~~~~~~~

Send your patches to sofia-sip-devel. Someone from the 
development team (see AUTHORS) will handle the patch.

People with CVS-access
~~~~~~~~~~~~~~~~~~~~~~

Trivial changes can be committed without review. For non-trivial 
changes, you should first send a proposal to sofia-sip-devel and
wait for comments. There are no strict approval rules so use of
common sense is recommended. ;)

Tips for making patches
~~~~~~~~~~~~~~~~~~~~~~~

- test your patch on a clean CVS-checkout
- remember to run cvs update before making commits