How to Create a New Project: Difference between revisions
Jump to navigation
Jump to search
| Line 5: | Line 5: | ||
=Procedure= | =Procedure= | ||
* Create the GitHub project. | |||
* Clone locally: | |||
<pre> | |||
git clone git@github.com:NovaOrdis/<project-name>.git | |||
</pre> | |||
* Start with [[project pom.xml|pom.xml]] | * Start with [[project pom.xml|pom.xml]] | ||
* Install [[project .gitignore|.gitignore]] | * Install [[project .gitignore|.gitignore]] | ||
Revision as of 00:59, 3 September 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 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-dir>
The <project-home-dir> can be specified as a relative or absolute directory.
For more details see novaordis-release-tools.
- 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
- 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.