From 1b7449a7ffa27812e664c48777af873dc61b63c7 Mon Sep 17 00:00:00 2001
From: ustieber
Date: Tue, 3 May 2011 16:35:24 +0000
Subject: Target Explorer: Add plug-in to hold documentation and related files

---
 target_explorer/docs/.project          | 11 +++++++++++
 target_explorer/docs/CONTRIBUTIONS.txt | 28 ++++++++++++++++++++++++++++
 target_explorer/docs/README.txt        | 17 +++++++++++++++++
 3 files changed, 56 insertions(+)
 create mode 100644 target_explorer/docs/.project
 create mode 100644 target_explorer/docs/CONTRIBUTIONS.txt
 create mode 100644 target_explorer/docs/README.txt

(limited to 'target_explorer')

diff --git a/target_explorer/docs/.project b/target_explorer/docs/.project
new file mode 100644
index 000000000..6a0059e36
--- /dev/null
+++ b/target_explorer/docs/.project
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>org.eclipse.tm.te.docs</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+	</buildSpec>
+	<natures>
+	</natures>
+</projectDescription>
diff --git a/target_explorer/docs/CONTRIBUTIONS.txt b/target_explorer/docs/CONTRIBUTIONS.txt
new file mode 100644
index 000000000..1d3f6fdd3
--- /dev/null
+++ b/target_explorer/docs/CONTRIBUTIONS.txt
@@ -0,0 +1,28 @@
+Target Explorer (Eclipse.org) Contributions
+===========================================
+
+1. Update the copyright header of modified source files and submit new files only with a valid copyright header.
+
+2. Format the contributions source files using the default "Eclipse [built-in]" formatter profile.
+
+3. Keep the javadoc comments up-to-date.
+	a) At minimum, classes, interfaces and all their public and protected members must be fully documented.
+	b) If modifying the signature of a method, or if the implementation changes to what has been documented,
+	   update the javadoc comment to reflect the current signature and/or implementation.
+
+4. Strict UI / core separation is a "must have".
+	a) The Target Explorer must be usable in headless environments.
+	b) SWT/JFace dependencies are seen as UI dependencies and are not welcome in core plug-in's.
+
+5. "org.eclipse.core.resources" is a discouraged dependency.
+	a) The Target Explorer must be usable in workspace less RCP environments (-data @none).
+	b) Contributions must be written in a way to not depend on the existence of a
+	   workspace.
+	c) Contributions depending either mandatory or optionally on "org.eclipse.core.resources"
+	   should come as separate plug-in's.
+
+6. Avoid sub component cross dependencies where ever possible
+	a) The Target Explorer must stay highly modular.
+	b) Product builder shall be able to pick only what they really need.
+	c) If unavoidable, weak dependencies like adapters and extension points are
+	   preferred over hard dependencies.
diff --git a/target_explorer/docs/README.txt b/target_explorer/docs/README.txt
new file mode 100644
index 000000000..415849962
--- /dev/null
+++ b/target_explorer/docs/README.txt
@@ -0,0 +1,17 @@
+Target Explorer Component (Eclipse.org)
+=======================================
+
+1) Copyright
+
+ **********************************************************************************
+ * Copyright (c) 2011 Wind River Systems, Inc. and others. All rights reserved.   *
+ * This program and the accompanying materials are made available under the terms *
+ * of the Eclipse Public License v1.0 which accompanies this distribution, and is *
+ * available at http://www.eclipse.org/legal/epl-v10.html                         *
+ **********************************************************************************
+
+2) Contributions
+
+Contributions to the Target Explorer are of course very welcome and highly appreciated.
+Before submitting a contribution, please make sure to read CONTRIBUTIONS.txt to avoid
+unnecessary time consuming reworks.
-- 
cgit v1.2.3