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 guide on tool integrations #178

Open
stephprince opened this issue Nov 21, 2024 · 0 comments
Open

Add guide on tool integrations #178

stephprince opened this issue Nov 21, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@stephprince
Copy link
Contributor

stephprince commented Nov 21, 2024

When labeling issues, I saw that there were several issues proposing to add tools to the glossary where the comments indicate that we wanted to test the tool ourselves. I think it could be helpful to formalize what this testing process looks like so other tool developers know what we are looking for in an integration.

This kind of guide could provide a brief overview of what we are looking for in some of these topics:

  • does it support read and/or write of NWB files (and do written files pass validation/inspection)
  • is there example code and documentation on where NWB is integrated
  • does it work when testing with different NWB files (would be helpful to provide some specific examples to use)
  • any other general suggestions to make integrations more robust (are specific versions of NWB required, are specific fields/data types expected, are extensions used and documented)

This guide is helpful for adding tools to the glossary, but seems primarily focused on sharing the tool after initial development vs. providing guidelines during development.

@stephprince stephprince added the documentation Improvements or additions to documentation label Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant