diff options
Diffstat (limited to 'target_explorer/docs/CONTRIBUTIONS.txt')
-rw-r--r-- | target_explorer/docs/CONTRIBUTIONS.txt | 28 |
1 files changed, 28 insertions, 0 deletions
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.
|