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

[ADD] issue template for proposals #19

Merged
merged 4 commits into from
Sep 15, 2020
Merged

[ADD] issue template for proposals #19

merged 4 commits into from
Sep 15, 2020

Conversation

remiadon
Copy link
Contributor

Issue template to follow every time
Example using this template to propose type indexing in BIDS-prov

Type-indexing on agents/activities/entities in BIDS-prov


Problem Statement

When defining new graphs in BIDS-prov we have no way to know the type of an object in advance.
If we want to find all entities in a given graph, we must iterate over the entire graph.
In addition, this layout currently makes reading of the graph harder, and spotting errors becomes tedious


Rationale

We propose to use a feature called type indexing, for all our graphs
This will allow to group nodes by type, and maybe to create a hierarchy in the future, accessing the most basic types at first and then descending in the graph for more specific types (eg. Agent vs Software Agent)


Minimal examples

Before

"@graph": [
        {
          "@id" : "dfsiosndfn1",
          "label" : "realign",
          "@type" : "prov:Activity",
        },
]

After

"@graph": {
        "prov:Activity" : [
        {
          "@id" : "dfsiosndfn1",
          "label" : "realign",
        },
    ]
}

Checklist

  • link to the google doc of the proposal : here
  • make sure the google doc follows the BIDS proposale template
  • list of all authors for this proposal : Satra Ghosh, Camille Maumet
  • links to related issues and PRs in bids-specification

@cmaumet cmaumet merged commit a3fd2ea into master Sep 15, 2020
@cmaumet cmaumet deleted the spec_issue_template branch September 15, 2020 07:20
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

Successfully merging this pull request may close these issues.

Create an issue template that we will use to propose updates on the spec [2h]
2 participants