Creating and maintaining a mathematical and statistical library that is accurate requires a greater degree of communication than might be the case for other components. It is important that developers follow guidelines laid down by the community to ensure that the code they create can be successfully maintained by others.
Developers are asked to comply with the following development guidelines. Code that does not comply with the guidelines including the word must will not be committed. Our aim will be to fix all of the exceptions to the "should" guidelines prior to a release.
Becoming involved with a community project such as Commons Math can at first appear to be very daunting. The Math projects motivations are to design and build a well thoughtout API. With this in mind, there is a great deal of review and discussion revolving around how and why a particular package is included or written into the project. It is understandable that individuals may have an interest in donating either their time or code to the project, and we want to promote this. For this reason, we are working to maintain guidelines for proposing additional packages or coding efforts within the project.
Submitting Issues:
Querying the Database:
Commons-math follows Code
Conventions for the Java Programming Language. As part of the maven
build process, style checking is performed using the checkStyle plugin,
using the properties specified in checkStyle.properties.
Committed code should generate no checkStyle errors.
Here is a list of relevant materials. Much of the discussion surrounding the development of this component will refer to the various sources listed below, and frequently the Javadoc for a particular class or interface will link to a definition contained in these documents.