How to Create a New Project: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 14: | Line 14: | ||
* Install [[project log4j.xml|log4j.xml]] in <tt>src/test/resources</tt> | * Install [[project log4j.xml|log4j.xml]] in <tt>src/test/resources</tt> | ||
* Create directories: <tt>src/main/java</tt>. | * Create directories: <tt>src/main/java</tt>. | ||
* Check out locally the latest version | * Check out locally the latest nort version and install the release tools and run wrappers: | ||
<pre> | <pre> | ||
.../novaordis-release-tools/src/main/bash/operations install-release-tools <project-home-dir> | .../novaordis-release-tools/src/main/bash/operations install-release-tools <project-home-dir> | ||
| Line 21: | Line 21: | ||
The <project-home-dir> can be specified as a relative or absolute directory. | The <project-home-dir> can be specified as a relative or absolute directory. | ||
For more details see [[ | For more details see [[nort]]. | ||
* Create the IntelliJ project (.idea based): File -> New -> Project from Existing Sources -> select the project directory -> Import project from external model -> Maven. | * Create the IntelliJ project (.idea based): File -> New -> Project from Existing Sources -> select the project directory -> Import project from external model -> Maven. | ||
* Install the copyright (see [[IntelliJ Copyright Configuration]]) | * Install the copyright (see [[IntelliJ Copyright Configuration]]) | ||
Revision as of 21:02, 26 November 2016
Internal
Procedure
- Create the GitHub project.
- Clone locally:
git clone git@github.com:NovaOrdis/<project-name>.git
- Start with pom.xml
- Install .gitignore
- Install log4j.xml in src/test/resources
- Create directories: src/main/java.
- Check out locally the latest nort version and install the release tools and run wrappers:
.../novaordis-release-tools/src/main/bash/operations install-release-tools <project-home-dir>
The <project-home-dir> can be specified as a relative or absolute directory.
For more details see nort.
- Create the IntelliJ project (.idea based): File -> New -> Project from Existing Sources -> select the project directory -> Import project from external model -> Maven.
- 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
- 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> ...
- Review projects patterns and initialize the structures that apply.
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.