Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 424687

Summary:	Add common top-level files to git repositories
Product:	[RT] RAP	Reporter:	Ralf Sternberg <rsternberg>
Component:	Releng	Assignee:	Project Inbox <rap-inbox>
Status:	RESOLVED FIXED	QA Contact:
Severity:	enhancement
Priority:	P3
Version:	2.3
Target Milestone:	2.3 M3
Hardware:	PC
OS:	Linux
Whiteboard:

Description Ralf Sternberg

2013-12-27 05:41:54 EST

I suggest to add these files to the root folder of our git repositories:

- README.md
  This file should explain what's in this repository, how it's structured, where to find additional information, and how to build.

- CONTRIBUTING.md
  Should explain how to contribute code. Github will add a link to this file when a contributor opens a pull request: https://github.com/blog/1184-contributing-guidelines

- LICENSE.md
  That's a common file to look for a project's license. I think we should add such a file and point to the relevant legal documents (epl-v10.html, notice.html) and the about.html files in the projects. I wonder if we should also move the legal documents from the o.e.rap.build project into the root folder.

- pom.xml
  A top-level build file that allows to build everything with a simple `mvn clean install`.

Comment 1 Markus Knauer

2014-04-24 10:09:52 EDT

README.md, CONTRIBUTING.md have been created for both projects, RAP Runtime + RAP Tools

In addition to that, there's now a pom.xml in the root of the Git repository that defines the modules to be built. In most cases I suggest to use a `mvn clean verify` instead of using the `install` goal because we don't want to copy the RAP bundles into the local Maven repository.

In the RAP Tools project it was necessary to rework the way the target definition file is loaded. Maybe it was a lucky coincidence that the old version worked, but with the separation between parent pom and module definition pom in the root directory the target definition file could not be loaded/resolved any more. The target definition file is now in its own module.

Unfortunately there is no LICENSE.md file in markdown format available, and we are not allowed to create one ourself without coordinating this with EMO / Eclipse Legal. But the EPL is referenced in the README.md and for the time being this should be enough.

* RAP Runtime https://git.eclipse.org/r/#/c/25483/
* RAP Tools https://git.eclipse.org/r/#/c/25477/

Comment 2 Markus Knauer

2014-04-25 10:26:24 EDT

Fixed.

Changes pushed to RAP Runtime (commit c040750d8e61e503e79a90f7bef7028ff8ed0226) + RAP Tools (commit 4e14ae63ab837ed89ccaafab75b22eb17295f94a).