How to Create a New Project: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 30: Line 30:
* Install nort configuration in .nort/project.yaml. A sample configuration file is provided here: [[Nort_Concepts#Per-Project_Configuration]]
* Install nort configuration in .nort/project.yaml. A sample configuration file is provided here: [[Nort_Concepts#Per-Project_Configuration]]


* Install [[project .gitignore|.gitignore]]
* Install [https://kb.novaordis.com/index.php/.gitignore#Reference_.gitignore reference .gitignore]


* Make src/test/resources in the library modules, or in the project home if the project is single-module:
* Make src/test/resources in the library modules, or in the project home if the project is single-module:
Line 68: Line 68:
** Development.  Each project has a development area accessible from its wiki page as "<project-name> Development".
** Development.  Each project has a development area accessible from its wiki page as "<project-name> Development".
*** GitHub (must contain the link to the GitHub project).
*** GitHub (must contain the link to the GitHub project).
*** Maven coordinates


* Link the NOKB project from README.md:
* Link the NOKB project from README.md:

Latest revision as of 05:53, 1 June 2018

Internal

Procedure

  • Create the GitHub project.
  • Clone locally:
cd ~/projects
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.
Release Module Structure
  • Make src/test/resources in the library modules, or in the project home if the project is single-module:
mkdir -p src/test/resources
  • Make src/test/java test root in the library modules, or in the project home if the project is single-module:
mkdir -p src/test/java
  • Make src/main/java in the library modules, or in the project home if the project is single-module:
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.
    • Use "User-Friendly Name (projects-dir-name)" naming pattern.
  • 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.
  • Verify tools
mvn clean install
release info
  • Create corresponding NOKB projects page:
    • Overview
    • User Manual. 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.
    • Development. Each project has a development area accessible from its wiki page as "<project-name> Development".
      • GitHub (must contain the link to the GitHub project).
      • Maven coordinates
  • Link the NOKB project from README.md:

...

# Documentation

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

...

TODO

  • Word Document in ./doc

Conventions