developer-info.md

layout	title
default	Developers

Information for developers: Standards, guidelines, and tools

Code

• ESGF GitHub Repository

---

Mailing lists

To join the developers mailing list, send an email to majordomo@lists.llnl.gov with the following in the body:

subscribe esgf-devel	

(For the users mailing list, see the mailing list page.)

Other Mailing lists for developer Working Groups

• Installation Working Group List esgf-install@lists.llnl.gov
• Server Side Working Group List esgf-server-side@lists.llnl.gov
• Networking Working Group List esgf-networking@lists.llnl.gov
• Security Authentication / ID Mgmt Working Group List esgf-security-auth@lists.llnl.gov
• Controlled Vocabulary Working Group esgf-ctrl-vocab@lists.llnl.gov
• Data Publishing Working Group esgf-data-pub@lists.llnl.gov

---

Standards

• NO TABS; instead use 4 spaces

  • For background behind this issues check out this or that site

• Java

  • For Java code please follow the Java Style Guide

  • For those of us special enough to use emacs, here is the .emacs entry to enforce space standards:

      (setq c-basic-offset 4)
      (setq tab-width 4)
      (setq indent-tabs-mode nil)
      (setq-default c-basic-offset 4)
      (setq-default indent-tabs-mode nil)
      (defun my-java-mode-hook ()
      (setq c-basic-offset 4)
      (setq indent-tabs-mode nil))
      (add-hook 'java-mode-hook 'my-java-mode-hook)
    

• Python

  • Project Layout
  • Source Code

Guidelines

• Do not javadoc with @author tag.
• Never commit into the repo what can be generated

Tools

• Version Control System: git
• Build: ant
• Dependencey Management: ivy
• Unit Testing: JUnit
• Test Coverage: Cobertura
• Artifact Repository: Artifactory, ESGF's Repo
• How To Participate
  • Join Mailing List
  • AskBot
  • Suggest changes give feedback to the community
  • Check out the repo
  • Develop changes
  • Make a pull request

Manifesto

Described here the inspiring principles according to which ESGF software modules should be developed:

• Modularity
• API, loose coupling
• Open source
• Open development
• Configurability, interfaces, plugins
• Layered applications
• Support for multiple languages (Java and Python)
• Agile: rapid prototyping, frequent demos and feedback, iterative development, reponsiveness