[JBoss JIRA] (FORGE-2362) Generated projects should contain a sample README.asciidoc
by Antonio Goncalves (JIRA)
[ https://issues.jboss.org/browse/FORGE-2362?page=com.atlassian.jira.plugin... ]
Antonio Goncalves commented on FORGE-2362:
------------------------------------------
Yes. Each time you create a new project with {{project-new}} it should generate a basic readme (I think it's a good practice to have) with at least some technical information, such as the name of the project and the type (war, ear). Another idea is, each time a Facet is installed, an event is sent (we've talked about this for the Swarm addon ;o) and a new line is added in the readme.
We could get some inspiration from [The Perfect Readme|http://fr.slideshare.net/netguru/perfect-project-read-me] and generate a structure as follow, with some information we can automatically add, but also leave blanks for the developper to add :
{code}
= ${projectName}
== General information
* ${projectName}
* // blah blah description
== Technologies
* ${language} // this would be mainly Java
* ${Database} // we can get this from JPA setup command
* ${applicationServer} // We can get this from javaee setup command
* ${List of installed facet}
== Setup
* ${buildSystem}} // Maven or gradle
* ${howToBuild}} // If it's Maven then we can say "use mvn clean install"....
* // blah blah about the config files (if any) passwords (if any)
== Development
* // blah blah Additional configuration to be able to develop
* // blah blah How to use in your IDE
== Tests
* // blah blah How to test the code
* ${Arquillian} // we know that from Arquillian setup command
* ${Junit} or ${testNG} // we know that from arquillian-setup command
== Common problems/bugs
* // blah blah Solution to common problems
== Access to staging/beta/production
* // Git repository, branches, tags
* // blah blah How can I access (user/passord)
== Notes
* ${codeStyle} // we can get this information from the code formatter
* // blah blah Any note
{code}
> Generated projects should contain a sample README.asciidoc
> ----------------------------------------------------------
>
> Key: FORGE-2362
> URL: https://issues.jboss.org/browse/FORGE-2362
> Project: Forge
> Issue Type: Feature Request
> Components: Projects
> Affects Versions: 2.16.2.Final
> Reporter: Antonio Goncalves
>
> When creating a new project with {{project-new}}, it should generate a basic {{README.asciidoc}} file.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)