Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

See Eclipse IDE Configuration on setting these standard in Eclipse.

Documentation of

...

SVN Commits

Every commitment to the project CVS or SVN at SVN source code repository on Sourceforge should be associated with (at least) one entry in JIRA, by including the JIRA issue key in the commit comment. Reformatting of source code should be done by separate commits with a comment like 'pretty format'. There are a few reasons for doing this:

  1. History. A year from now, I need to be able to look at the history of a file and understand what changes were made to it, and why they were done. This is necessary for software maintenance of a large project.
  2. Education. People can look at the commit log or notification and begin to understand the source code through the descriptions of commits.
  3. Traceability. Tracing every commit to a JIRA issue allows a bit of workflow around the software development, and impedes frivolous software changes. Being able to trace every change to a documented issue also helps organizations that want to perform some certification around the softare.

About resolving and closing issues in JIRA

...