How to Create a New Project: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
Line 18: Line 18:
* Create the first class and the corresponding test.
* Create the first class and the corresponding test.
* Start a new empty <tt>./doc/release-notes.txt</tt>. This file is used to collect release notes that will be published with the release announcement.
* Start a new empty <tt>./doc/release-notes.txt</tt>. This file is used to collect release notes that will be published with the release announcement.
* Verify tools
<pre>
mvn clean install
release info
</pre>


=Conventions=
=Conventions=

Revision as of 00:02, 28 July 2016

Internal

Procedure

  • Start with pom.xml
  • Install .gitignore
  • Install log4j.xml in src/test/resources
  • Create directories: src/main/java.
  • Check out locally the latest version of "novaordis-release-tools" and install the release tools and run wrappers:
.../novaordis-release-tools/src/main/bash/operations install-release-tools <project-home>

For more details see novaordis-release-tools.

  • Create the IntelliJ project (.idea based)
  • Install the copyright (see IntelliJ Copyright Configuration)
  • Create the first class and the corresponding test.
  • Start a new empty ./doc/release-notes.txt. This file is used to collect release notes that will be published with the release announcement.
  • Verify tools
mvn clean install
release info

Conventions

  • Each project has user manual accessible from its wiki page as "<project-name> User Manual". The user manual should be ready for publishing at any time.
  • Each project has a development area accessible from its wiki page as "<project-name> Development".
  • The TODO list is maintained in the TODO section of the development manual.