New guidelines for developpers #319
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@gdevenyi please review contributing.md |
gdevenyi
requested changes
Oct 2, 2023
| @@ -22,7 +22,7 @@ | |||
| author = 'CoBrALab' | |||
|
|
|||
| # The full version, including alpha/beta/rc tags | |||
| release = '0.4.6' | |||
There was a problem hiding this comment.
This should be a seperate commit
Comment on lines
+21
to
+25
| 1. On github, fork the RABIES repository to have your own copy. | ||
| 2. Clone your repository to carry out local modifications and testing. Use the `--recursive` option to download the submodules together with the main RABIES package. | ||
| 3. Make your modifications to the code. | ||
| 4. Testing and debugging: install your updated version of the package with ```python setup.py install```, using a proper dev environment (see above). Your can test the workflow with specific parameters by editing the ```debug_workflow.py``` script, and executing in debug mode with Spyder (see below). Before commiting changes, make sure that running ```error_check_rabies.py``` completes with no error. | ||
| 5. Commit and push your modifications to Github, and create a pull request from your forked repo to the original. |
There was a problem hiding this comment.
You need to mention making a branch
| @@ -5,4 +5,4 @@ sphinx-rtd-theme | |||
| sphinxcontrib-bibtex | |||
| sphinxcontrib-programoutput==0.17 | |||
| jinja2==3.1.1 | |||
| rabies==0.4.7 | |||
There was a problem hiding this comment.
this should have a seperate commit with the version changes above
| import os | ||
| import pathlib | ||
| import SimpleITK as sitk | ||
| import numpy as np |
There was a problem hiding this comment.
This is another separate commit
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.