Sounds awesome @albert !
First you’d need to create a GitHub account if you haven’t got one, then you’d fork the ITKExamples repository. You’d then clone it, and configure your
upstream remotes to point to your fork and the upstream/ITK repositories respectively.
Then the you typically create a new branch, e.g.
git checkout -b AddMyExample origin/master
AddMyExample should be a meaningful name for your example. You’d then add your files to the commit, add a meaningful, self-contained and complete commit message, push your branch to your
GitHub would suggest opening a Pull Request. You’d be willing to add reviewers to approve or suggest modifications to the PR. You can add me or other fellows, for example.
If by (…) implementing the Python script (…) you mean the multi-scale vessel enhancement example Matt pointed, that would be it. Do not forget to add your Python
Code.py file to the
CMakeLists.txt file, and to the reSTructured Text (
*.rst) file that is finally rendered, much like Matt did for his PR. Matt also took advantage to increase consistency in the code style, which would also be great for the mentioned example if necessary.
If by (…) implementing the Python script (…) you mean a complete new example, that would also be great. You’d need to create a new folder in the same category of the mentioned examples, and provide the
CMakeLists.txt file, the
*.rst file, the C++
Code.cxx and Python
Code.py files, and the SHA512 files of the images produced. Once you have your output images, ITK provides a few ways to generate the hashes.
The complete contributing manual is found here.
Let us know if this works for you.
Thanks for your contributions.