Uploaded image for project: 'Commons Math'
  1. Commons Math
  2. MATH-852

Improvements to the Developer's Guide

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: 4.X

      Description

      Recent discussions (see MATH-851, as well as these threads 1, 2) have shown that our actual requirements (especially regarding formatting) are higher than stated in the Developer's Guide. This leads to confusion among new contributors, as well as recent committers. It is therefore proposed to revise this guide, in order for it to reflect the actual expectations regarding submitted code.

      This guide should however not act as a deterrent for new contributors, so attention should be paid to "rules" we consider as essential vs. superfluous rules.

      Here is an extract of the developer's guide in its current state

      Coding Style

      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.xml. Committed code should generate no Checkstyle errors. One thing that Checkstyle will complain about is tabs included in the source code. Please make sure to set your IDE or editor to use spaces instead of tabs.

      Committers should make sure that svn properties are correctly set on files added to the repository. See the section on Committer Subversion Access on the Apache Source Code Repositories page.

      Documentation

      • Committed code must include full javadoc.
      • All component contracts must be fully specified in the javadoc class, interface or method comments, including specification of acceptable ranges of values, exceptions or special return values.
      • External references or full statements of definitions for all mathematical terms used in component documentation must be provided.
      • Implementations should use standard algorithms and references or full descriptions of all algorithms should be provided.
      • Additions and enhancements should include updates to the User Guide.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              celestin Sebastien Brisard
            • Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

              • Created:
                Updated: