Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorustieber2011-05-03 12:35:24 -0400
committerustieber2011-05-03 12:35:24 -0400
commit1b7449a7ffa27812e664c48777af873dc61b63c7 (patch)
tree13ad3cdab9d58e049a07c2061270190f38090612 /target_explorer/docs
parent8f829a933197b4b0a3b25e012b497c6801ad4dd5 (diff)
downloadorg.eclipse.tcf-1b7449a7ffa27812e664c48777af873dc61b63c7.tar.gz
org.eclipse.tcf-1b7449a7ffa27812e664c48777af873dc61b63c7.tar.xz
org.eclipse.tcf-1b7449a7ffa27812e664c48777af873dc61b63c7.zip
Target Explorer: Add plug-in to hold documentation and related files
Diffstat (limited to 'target_explorer/docs')
-rw-r--r--target_explorer/docs/.project11
-rw-r--r--target_explorer/docs/CONTRIBUTIONS.txt28
-rw-r--r--target_explorer/docs/README.txt17
3 files changed, 56 insertions, 0 deletions
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.

Back to the top