Using draw.io With GitHub

ELFIE will use draw.io for collaboratively editing diagrams.

How we work collaboratively will be determined through experience, but here are some guidelines to get you started.

1. When working on a diagram, open an issue describing what you are doing, assign yourself to it, and comment that you are actively working on a particular file. This will help us avoid conflicting commits.
2. Please only edit diagrams in your personal fork of the repository. We may decide that diagrams can be edited directly in the group repository but for the time being, please only submit changes through a pull request from your fork.

To get hooked up to draw.io,

1. go there and select "GitHub" as the place to save diagrams.
2. Click "Open Existing Diagram" and click through the GitHub authorization if it isn't already set up.
3. Scroll to your personal fork of the ELFIE repository and navigate to the diagram you want to edit.
4. Make your desired edits.
5. Click save and enter a commit message. If your commit fixes your open issue, add "fixes #1234" where 1234 is the issue number.
6. Open a pull request https://github.com/opengeospatial/ELFIE/pulls and assign a reviewer if needed.
7. To help with review, put a screen shot of your diagram in the pull request. This can be done by dragging an image into the description or a comment field.

These procedures will likely evolve as time goes on and we may or may not use these diagrams a lot, time will tell.