-
Notifications
You must be signed in to change notification settings - Fork 3
Submitting Your Dandiset Example Live Script(s)
This library collects together examples from diverse independent contributors. To accomplish this:
- Each example artifact (original or derivative) is located in its own folder with its own license file
- Each example artifact (original or derivative) has a named owner (organization/lab/individual)
To submit an example artifact, example authors should submit a GitHub pull request adding a new folder to the repository contents & following the guidelines below. Library admins will review the pull request.
Before submitting, example authors should carefully consider whether their example original will be:
- Library Hosted (the library acts as the host for the example original), or
- Externally Hosted (the library mirrors the example original hosted elsewhere)
Guidelines are provided for both cases below.
<dandiset id>/<org or individual- first commit year>/<mnemonic>/<code>
Natively hosted examples should use a permissive license option from ChooseALicense.com, e.g. MIT or BSD.
<dandiset id>/<external repository org or individual>/<external repository name>/<code>
To duplicate the external example in the library, examples can be either copied (easier) or mirrored (more flexible), as described below.
IF the external example repository uses:
THEN the external example owner has the option to simply copy specific release contents into the DANDI example repository. This is (for some) a simpler option than the Mirrored Example option below (which uses git submodule).
This simplicity comes with one author responsibility: the cloned example README should be minimally modified to include a header that 1) points to source repository & 2) identifies the release copied. If the copied release is later updated (e.g., for new releases), this header should be updated accordingly in the example library.
Besides the convenient case of Cloned Examples outlined above, git submodule is the expected workflow to mirror the example from the source repository to the example library.