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

Make site with best practices for OBO ontologies that go beyond principles #1579

Open
matentzn opened this issue Aug 24, 2021 · 7 comments
Open
Labels
attn: Outreach WG Issues pertinent to outreach activities, such as user interactions and documentation documentation Issues related to documentation presented on the website or relevant to Foundry-provided tools principles Issues related to Foundry principles website Issues related to the OBO Foundry website

Comments

@matentzn
Copy link
Contributor

matentzn commented Aug 24, 2021

Releases

  • Keep your edit file (the file you change on a regular basis) and your release files strictly separate
  • Imports should be merged into the main release file

Collaboration

@cthoyt
Copy link
Collaborator

cthoyt commented Aug 24, 2021

@matentzn can you add instructions on the top of this issue how the best place to suggest new "recommendations"?

For example, I think all ontologies should disclose their funding situation/longevity plan before getting accepted. If development for an ontology will halt immediately following OBO Foundry acceptance, this should be considered before accepting. If a group commits to maintaining their ontology but then abdicates responsibility, then there should be some kind of note that shows this happened based on their original assessment

@matentzn
Copy link
Contributor Author

I think these kinds of recommendations are extremely difficult to proof - and it's also not so much a best practice as it would be an OBO foundry principle.. it seems like an obvious thing to add to the principles, but as far as I understand from many past discussions it's also misleading; for example PATO and RO have no core funding, but they get dragged along by other projects that rely on them (but not explicitly in a grant type of way). An alternative would be to ask for funding sources in the New Ontology Request.. not sure..

@matentzn
Copy link
Contributor Author

matentzn commented Aug 25, 2021

In any case, just making comments here is fine, I will collate the recommendations later and run it by the community for voting. Best practice though is not meant to be something that should be covered by OBO principles, just things that are great but sort of on the sidelines.

@nlharris nlharris added usability feature Issues pertinent to website and tools usability website Issues related to the OBO Foundry website labels Aug 25, 2021
@nataled
Copy link
Contributor

nataled commented Dec 7, 2021

In terms of branding, bear in mind that we (and others) often refer to the principles as 'best practices', so keep that in mind when deciding what to call these. Straw man: 'principles extensions'.

@nlharris nlharris added principles Issues related to Foundry principles attn: Outreach WG Issues pertinent to outreach activities, such as user interactions and documentation documentation Issues related to documentation presented on the website or relevant to Foundry-provided tools and removed usability feature Issues pertinent to website and tools usability labels Dec 14, 2021
@nlharris
Copy link
Contributor

nlharris commented Sep 1, 2022

This could be (and kind of already is) part of the OBOOK (https://oboacademy.github.io/obook/)

@cthoyt
Copy link
Collaborator

cthoyt commented Sep 1, 2022

Also there are now two automated assessments I wrote:

  1. https://cthoyt.com/obo-community-health/ assesses how active repositories actually are (spoilers, most of them aren't active at all, and prove my theory that many become inactive immediately after acceptance)
  2. https://cthoyt.com/oquat/ assesses how semantically meaningful the references inside ontologies are (there's a lot to be desired)

@nataled
Copy link
Contributor

nataled commented Sep 26, 2023

Related issue collecting potential examples: #2453

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
attn: Outreach WG Issues pertinent to outreach activities, such as user interactions and documentation documentation Issues related to documentation presented on the website or relevant to Foundry-provided tools principles Issues related to Foundry principles website Issues related to the OBO Foundry website
Projects
None yet
Development

No branches or pull requests

4 participants