| Re: [elk-dev] New models repository |
Hi, right, I have added a README.md file to the repository that explains the directory structure. Also, we will need to include licence headers in all files that support comments. To make that easier, I have also added a Python script to add such headers to either all files, a given selection of files, files currently staged for commit, or files changed in a past commit. The script can also update existing licence headers to include the current year. It supports a whole number of file types, which should also make it suitable to be run on our main repository from time to time. Cheers, Chris On 10/07/17 17:04, Christoph Daniel Schulze wrote: > Hi everyone! > > Following up on the recent discussion on a new models repository, we now > have one. The Oomph setup will clone it automatically (it will turn up > in the "ELK Stuff" working set and be named "ELK Models Folder"). > > We do have to settle on a convention to organize it. Here's what we have > brainstormed during a recent meeting: > > 1. The repository will contain models in three different formats: .elkt, > .elkg, and .json. > > 2. Three top-level folders: > > - "tests" will contain test graphs that we have written / generated. > > - "realworld" will contain graphs we obtained from real-world > examples, such as Ptolemy diagrams converted to ELK graphs. > > - "tickets" will contain graphs specific to tickets in out GitHub > issue management system. > > 3. "tests" and "tickets" contain further folders for test graphs > specific to layout algorithms, e.g. "layered", "force", or "common". For > "tests", these folders can contain further subfolders that differentiate > between test cases. > > 4. Folders may contain readme files that explain what kinds of graphs > the folder should contain. > > 5. Graphs might have to contain a license header as well. I'll ask the > legal team about that and hope for a "no", since we don't ship those > files anyway. > > Thus, the repository could look something like this (the file names are > only meant to be simple examples): > > / > realworld/ > ptolemy/ > cu_carTracking.elkt > ptolemy_flat/ > cu_carTracking.elkt > tests/ > common/ > connected_graph_01.elkt > disconnected_graph_01.elkt > layered/ > edge_labels/ > center_01.elkt > hyperedges/ > long_edges_01.elkt > tickets/ > layered/ > 124/ > small_example.elkt > large_example.elkt > > Comments? > > Cheers, > Christoph Daniel > > > > _______________________________________________ > elk-dev mailing list > elk-dev@xxxxxxxxxxx > To change your delivery options, retrieve your password, or unsubscribe from this list, visit > https://dev.eclipse.org/mailman/listinfo/elk-dev >
Attachment:
signature.asc
Description: OpenPGP digital signature