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 more details to how to contribute #222

Merged
merged 1 commit into from
Oct 16, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions doc/library.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ How to contribute

TODO: explain with more details

1. Generate the JSON file with probeinterface function (or directly
1. Generate the JSON file with probeinterface (or directly
with another language)
2. Generate an image with `plot_probe`
3. Clone with gin client the `probeinterface_library repo <https://github.com/SpikeInterface/probeinterface_library>`_
4. Put files in the right place.
5. Push to a branch with git client
6. Make a pull request on the gin portal (like a github PR)
2. Generate an image of the probe with the `plot_probe` function in probeinterface
3. Clone the `probeinterface_library repo <https://github.com/SpikeInterface/probeinterface_library>`_
4. Put the JSON file and image into the correct folder or make a new folder (following the format of the repo)
5. Push to one of your branches with a git client
6. Make a pull request to the main repo