Skip to content
This repository has been archived by the owner on Jul 25, 2018. It is now read-only.

Dev DoD and Style

Jump to bottom
Michael edited this page May 3, 2016 · 16 revisions

The definition of done helps to set a common understanding for solving a ticket.

Definition of done policy

  • Review points should involve one person from another angle (not just the person you were sitting together with anyways)
  • Limit items in review to 5, try to coordinate

Using Github assignments to issues or pull requests

  • Open review items require conversation

Definition of done items

  • File headers in file OK

  • GPLv2 w/ classpath exception license

  • Or, if the file is too small, configuration file: license note (see code style)

  • Copyright and author

  • Avoid (serious) compiler warnings

  • Fast forward merge to master

  • That means that merge to master is prepared

  • No breaking test

  • Unit testing as it is already present

  • You have more - use them!

  • New test

  • For new / added functionality

  • Documentation

  • in the Githuib Wiki-Section, if you have done something new

  • At least a technical note for newly added functionality

  • Review

  • Code style, not really formatting, but issues like style attributes in HTML tags (just s an example)

  • DoD items reached

  • Design / architecture issues

  • Community contribution suitability

  • Issue coverage (does it actually solve the problem?)

  • Explicitly:

review-by:[email protected]

and

tested-by:[email protected]

Licensing and file header

All files contributed require headers - this will ensure the license and copyright clearing at the end. Also, all contributions must have the same license as the original source.

If a file has relevant functionality

/*
 * Copyright COPYRIGHT HOLDER, 20XX. Part of the SW360 Portal Project.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License Version 2.0 as published by the
 * Free Software Foundation with classpath exception.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License version 2.0 for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program (please see the COPYING file); if not, write to the Free
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

(please adapt comment characters usage)

For small files such as property files, configuration files or standard XML files:

#
# Copyright COPYRIGHT HOLDER, 20XX. Part of the SW360 Portal Project.
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright
# notice and this notice are preserved.  This file is offered as-is,
# without any warranty.
#

Code style

Just use the standard Java formatting rules of your IDE and do not reformat code from others because you like to correct formatting of other's code.

Clone this wiki locally