Difference between revisions of "Policies"

From ADempiere
Jump to: navigation, search
This Wiki is read-only for reference purposes to avoid broken links.
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
==Policies==
+
There are a couple of written and unwritten rules Adempiere developers ususally adhere to. The following documents summarize some of these policies. The list is still incomplete. If you are interested in helping out with formulating the Adempiere policies or would like to discuss them please use the discussion page here or post into the Adempiere Developer Forum.
  
−
There are a couple of written and unwritten rules Adempiere developers ususally adhere to. The following documents summarize some of these policies. The list is still incomplete. If you are interested in helping out with formulating the Adempiere policies or would like to discuss them please use the Adempiere-policies mailing list which was created for this purpose.
+
==Policies for Developers==
−
Policies for Developers
+
  
−
These policies apply to Adempiere developers and it is expected that all persons with a Adempiere SVN account follow these policies. The SVN commit policy is the most important one. Persons working on libraries should read the library documentation policy.
+
These policies apply to Adempiere developers and it is expected that all persons with a Adempiere SVN account follow these policies. The SVN commit policy is the most important one.  
  
−
[[SVN Commit Policy]]
+
==SVN Commit Policy==
  
−
Rules for commits to the Adempiere SVN repository. The three golden rules (make sure it compiles, follow existing coding style, use descriptive log messages) and 18 more rules to follow to make sure that your SVN commits are the best they can be.
+
The three golden rules are - make sure it compiles, follow existing coding style and use descriptive log messages. Also, it is important to always include the related tracker number and description in the commit log message.
  
−
[[Licensing Policy]]
+
==Licensing Policy==
  
−
Files in Adempiere SVN cannot be arbitrarily licensed. This policy explains what licenses are allowed where in the repository. In short: use LGPL for libraries, CPL for everything else.
+
Files in Adempiere SVN cannot be arbitrarily licensed. This policy explains what licenses are allowed in the repository. In short: use LGPL for libraries, GPL for everything else.
  
−
[[Library Documentation Policy]]
+
==Source Documentation Policy==
  
−
Libraries for (re)use should be completely documented. This policy explains why they should be documented as well as how to document things, and what style to follow. The apidox howto contains more technical information on writing documentaton for libraries.
+
All methods should be completely documented using standard javadoc convention.
−
 
+
−
[[Library Code Policy]]
+
−
 
+
−
Adempiere Library API and Code should follow some conventions that are explained in this policy * URI & XML Namespaces Policy
+
−
 
+
−
Sometimes Adempiere technologies and applications needs URIs, such as for XML formats. This policy describes practices for that, and how to allocate URIs.
+
−
 
+
−
==Procedures==
+
−
 
+
−
Whereas policies are normative for individual developers -- that is, they describe how developers must behave -- procedures describe how 'the Adempiere project' as a whole has chosen to behave. We describe what we will do under certain circumstances and why.
+
−
 
+
−
[[Security Policy]]
+
−
 
+
−
How security problems can be reported to security@kde.org and how the security team responds to security issues.
+
−
 
+
−
[[Package Policy]]
+
−
 
+
−
This describes KDE's viewpoint on binary packages and elaborates the statement 'Adempiere provides source.'
+

Latest revision as of 22:11, 23 March 2007

There are a couple of written and unwritten rules Adempiere developers ususally adhere to. The following documents summarize some of these policies. The list is still incomplete. If you are interested in helping out with formulating the Adempiere policies or would like to discuss them please use the discussion page here or post into the Adempiere Developer Forum.

Policies for Developers

These policies apply to Adempiere developers and it is expected that all persons with a Adempiere SVN account follow these policies. The SVN commit policy is the most important one.

SVN Commit Policy

The three golden rules are - make sure it compiles, follow existing coding style and use descriptive log messages. Also, it is important to always include the related tracker number and description in the commit log message.

Licensing Policy

Files in Adempiere SVN cannot be arbitrarily licensed. This policy explains what licenses are allowed in the repository. In short: use LGPL for libraries, GPL for everything else.

Source Documentation Policy

All methods should be completely documented using standard javadoc convention.

Retrieved from "http://www.adempiere.com/index.php5?title=Policies&oldid=23494"