Skip to content

Commit 49ae04f

Browse files
author
Christoph Daniel Schulze
committed
General: Add contribution documentation.
1 parent 07952f9 commit 49ae04f

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

CONTRIBUTING.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Contributing to Eclipse Layout Kernel
2+
3+
Thanks for your interest in this project.
4+
5+
## Project description
6+
7+
Visual languages are popular for visualizing concepts and systems. However, just
8+
being graphical in nature does not automatically make a diagram easy to
9+
understand. Its usefulness much rather depends on the placement of its elements,
10+
that is: on its layout. Getting the layout right is labour intensive and time
11+
consuming and can be made a lot easier by making algorithms do the work. The
12+
Eclipse Layout Kernel (ELK) provides such layout algorithms, as well as an
13+
infrastructure to connect them to diagram editors.
14+
15+
* https://www.eclipse.org/elk/
16+
17+
## Developer resources
18+
19+
Information regarding source code management, builds, and more.
20+
21+
* https://www.eclipse.org/elk/documentation/contributors.html
22+
23+
The project maintains the following source code repositories
24+
25+
* https://github.com/eclipse/elk
26+
* https://github.com/eclipse/elk-models
27+
28+
## Eclipse Contributor Agreement
29+
30+
Before your contribution can be accepted by the project team contributors must
31+
electronically sign the Eclipse Contributor Agreement (ECA).
32+
33+
* http://www.eclipse.org/legal/ECA.php
34+
35+
Commits that are provided by non-committers must have a Signed-off-by field in
36+
the footer indicating that the author is aware of the terms by which the
37+
contribution has been provided to the project. The non-committer must
38+
additionally have an Eclipse Foundation account and must have a signed Eclipse
39+
Contributor Agreement (ECA) on file.
40+
41+
For more information, please see the Eclipse Committer Handbook:
42+
https://www.eclipse.org/projects/handbook/#resources-commit
43+
44+
## Contact
45+
46+
Contact the project developers via the project's "dev" list.
47+
48+
* https://dev.eclipse.org/mailman/listinfo/elk-dev

0 commit comments

Comments
 (0)