How to Create a New Project

From NovaOrdis Knowledge Base
Revision as of 06:56, 2 January 2017 by Ovidiu (talk | contribs) (→‎Procedure)
Jump to navigation Jump to search

Internal

Procedure

  • Create the GitHub project.
  • Clone locally:
git clone git@github.com:NovaOrdis/<project-name>.git
  • Decide whether the project is a simple library project, and thus requires a simple structure, or it has an installable binary and it requires at least a "main" and a "release" module.
  • Make src/test/resources:
mkdir -p src/test/resources
  • Install log4j.xml in src/test/resources
  • Make src/main/java:
mkdir -p src/main/java
  • Create the IntelliJ project (.idea based): File -> New -> Project from Existing Sources -> select the project directory -> Import project from external model -> Maven.
  • Create the first class and the corresponding test.
  • Start a new empty ./doc/release-notes.md. This file is used to collect release notes that will be published with the release announcement.
  • If the project is released as an executable binary, configure the embedded installation logic following the procedure described here: Embedded Installation Logic for Binary Distributions. nort will know to use the installation logic artifacts created according to the procedure.
  • Verify tools
mvn clean install
release info
  • Create corresponding NOKB page:
    • Overview
    • User Manual
    • Development
      • GitHub (must contain the link to the GitHub project).
  • Link the NOKB project from README.md:

...

# Documentation

https://kb.novaordis.com/index.php/<project-name>

...

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.