Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Develop a mechanism for practices documents #16

Open
jakebeal opened this issue Apr 27, 2022 · 4 comments
Open

Develop a mechanism for practices documents #16

jakebeal opened this issue Apr 27, 2022 · 4 comments
Assignees

Comments

@jakebeal
Copy link
Contributor

Things like SynBioDex/SBOL-specification#9 actually belong in separate "practices" documents that recommend how to use SBOL to represent common use cases.

Similarly, some of the material in the best practices section really belong in separate documents (e.g., representation of media, multi-cellular systems)

We do not currently have a means of actually maintaining such documents however. Should they be in this repository or in other repositories? Do they need to be blessed by SEPs? Do they get published by JIB?

These issues need to be worked out as a process SEP.

@jakebeal
Copy link
Contributor Author

Known issues that need this: #7, #6, #8, #9

@cjmyers
Copy link
Contributor

cjmyers commented May 11, 2022

  1. For a potential best practice example, open a discussion topic on the sbol-editors repository.
  2. If an issue exists on this topic, link to it to see the past discussion, but have all future discussion on the discussion thread.
  3. When a solution is being formulated, create a markdown description following the SEP format. Where appropriate, there should be fully formulated SBOL example(s).
  4. When the solution appears to have achieved consensus (determined by the SBOL editors), then a link to this solution is added to the FAQ on the SBOL standard website.
  5. Note that not all discussion topics need to ever be promoted to best practices linked on the FAQ.

@cjmyers
Copy link
Contributor

cjmyers commented May 11, 2022

We are going to use SEP 055 as a test case for this workflow.

@Gonza10V
Copy link
Contributor

Now @PrashantVaidyanathan is doing the SBOL Examples, but I'm happy to help

@LukasBuecherl LukasBuecherl transferred this issue from SynBioDex/SBOL-specification Oct 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants