catalystneuro / .github Goto Github PK

NeurodataWithoutBorders and DANDI both have a general helpdesk location for questions/difficulties spanning the ecosystem.

Should we have one as well? Thoughts? @h-mayorquin @luiztauffer @bendichter

This repository's .gitignore should serve as a common template for CatalystNeuro projects. Currently the .gitignore is just a replication of roiextractor's.

They're such a nicer formatting, even if it's just for a single empty box.

Also, add the general redirect menu to help people navigate to important places.

Use our well-established logo to decorate README/project

The docstring checks are a great idea but I think as they currently stand they are a bit too strict for adoption across our repos. I would like to request 3 changes:

1. Functions and methods. I think it makes sense to enforce that all functions and methods must either be marked as private with a _ or have a docstring, especially since it appears this is critical for autodoc to work. For private methods, this should not be enforced.

2. modules. For modules, I have found it annoying and often repetitive to need to create docstrings for basic __init__.py files.
For example these lines:

https://github.com/catalystneuro/roiextractors/blob/da6d79103d5841cae3c2087d230fc18f608c4a4a/src/roiextractors/extractors/hdf5imagingextractor/hdf5imagingextractor.py#L1-L7

are repetitive with these lines:

https://github.com/catalystneuro/roiextractors/blob/da6d79103d5841cae3c2087d230fc18f608c4a4a/src/roiextractors/extractors/hdf5imagingextractor/__init__.py#L1-L13

Would it be possible to relax the check so that the __init__.py files were skipped? A developer could still write a docstring for these, but I don't think it should be required.

3. More flexibility. Could we add parameters that allows this check to skip modules or to skip functions?

4. File organization Could we separate workflows from workflow definitions? Currently, call_check_docstrings.yaml is in the same directory is check_docstrings.yml, which I find confusing. I think .github/workflows should be reserved for files that are specifying workflows to be run on that repo, so call_check_docstrings.yaml should be there (possibly renamed to check_docstrings.yaml) and the current check_docstrings.yml should be moved to /workflow_definitions.

From @alessandratrapani's presentation at the retreat

Make an onboarding checklist

• how to use toggl (official company policy statement would be nice)
• how to use github
• how to use slack
• how to use globus (existing docuemnts just add link)
• how to use rclone and the google drive

How to approach a conversion project

• NWB self-training (youtube videos, but in a recommended order, etc)
• CN GitHub workflow intro
• conversion project example, hopefully a small simple one, but could be any active project right now?

Also move NeuroConv coding style here