README.developers 2.72 KB
Newer Older
Pekka Pessi's avatar
Pekka Pessi committed
1 2 3 4 5
===============================================================
README.developers - Sofia-SIP development practises
===============================================================

Introduction
Pekka Pessi's avatar
Pekka Pessi committed
6
============
Pekka Pessi's avatar
Pekka Pessi committed
7 8 9 10 11 12 13 14

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
Pekka Pessi's avatar
Pekka Pessi committed
15
==============================
Pekka Pessi's avatar
Pekka Pessi committed
16 17 18 19 20 21 22 23 24

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.

Pekka Pessi's avatar
Pekka Pessi committed
25
TODO
Pekka Pessi's avatar
Pekka Pessi committed
26 27
	Not in active use yet.

Pekka Pessi's avatar
Pekka Pessi committed
28
<dir>/ChangeLog files
Pekka Pessi's avatar
Pekka Pessi committed
29 30 31 32 33
	All non-trivial changes to the source code should
	be documented in the ChangeLog files.


Version numbering 
Pekka Pessi's avatar
Pekka Pessi committed
34
=================
Pekka Pessi's avatar
Pekka Pessi committed
35 36

Package version
Pekka Pessi's avatar
Pekka Pessi committed
37
---------------
Pekka Pessi's avatar
Pekka Pessi committed
38 39

For public releases, the package version is:
40
     vMAJOR.MINOR.REVISION, where MINOR is even
Pekka Pessi's avatar
Pekka Pessi committed
41

42 43 44
For development releases and snaphots the version is one of:
     vMAJOR.MINOR.REVISION, where minor is odd
     vMAJOR.MINOR.REVISION.YEAR.MONTH.DAY, where minor is odd
Pekka Pessi's avatar
Pekka Pessi committed
45

46
For all releases, the version should be changed in configure.ac 
47
and committed to Darcs/CVS before making the release package. The person 
48
doing the release is responsible for updating the version number.
Pekka Pessi's avatar
Pekka Pessi committed
49 50 51


Library interface versions
Pekka Pessi's avatar
Pekka Pessi committed
52
--------------------------
Pekka Pessi's avatar
Pekka Pessi committed
53 54 55 56

TBD


Pekka Pessi's avatar
Pekka Pessi committed
57 58 59
Version control tags
====================

60 61
Tagging releases and snapshots
------------------------------
Pekka Pessi's avatar
Pekka Pessi committed
62

63 64 65 66 67
- source repository (*)
    - master Darcs tree at:
      http://dev-126.openlaboratory.net/repos/sofia-sip
    - CVS tree (only used to track major releases) at:
      http://sourceforge.net/cvs/?group_id=143636
Pekka Pessi's avatar
Pekka Pessi committed
68 69
- tags: rel-sofia-sip-x_y_z
    - stable and development releases (matches release 
Pekka Pessi's avatar
Pekka Pessi committed
70
      version sofia-sip-x.y.z)
Pekka Pessi's avatar
Pekka Pessi committed
71 72 73 74
- tags: snapshot_rel_YEARMMDD
    - snapshot releases at
      http://sofia-sip.sourceforge.net/snapshots/

75 76 77 78
Notes (*):
    - Information about Darcs:
      http://abridgegame.org/darcs/
      http://lwn.net/Articles/110516/
Pekka Pessi's avatar
Pekka Pessi committed
79

Pekka Pessi's avatar
Pekka Pessi committed
80
Sending patches
Pekka Pessi's avatar
Pekka Pessi committed
81
===============
Pekka Pessi's avatar
Pekka Pessi committed
82

83 84
People without Darcs access
---------------------------
Pekka Pessi's avatar
Pekka Pessi committed
85 86 87 88

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

89 90
People with Darcs access
------------------------
Pekka Pessi's avatar
Pekka Pessi committed
91 92 93 94 95 96 97

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
Pekka Pessi's avatar
Pekka Pessi committed
98
-----------------------
Pekka Pessi's avatar
Pekka Pessi committed
99

100 101 102 103
- test your patch on a clean checkout from version control system
- remember to check for updates before pushing your changes
  to the master repository

Pekka Pessi's avatar
Pekka Pessi committed
104