Contributing
Thank you for your interest in contributing to Spinal Cord Toolbox! 🎉
Below you'll find some steps to help get you started with contributing:
- Project overview: Start with this page, which will give you a bird's eye view of how SCT's codebase is structured, as well as provide you with some background context on what SCT is and how it's used.
- "good first issues": These are small tasks that will help you get familiar with SCT's typical workflow (opening a branch, submitting a pull request, receiving a PR review, and responding to feedback).
- Submitting changes to SCT (Opening a Pull Request): Once you've found an issue to tackle, this page will provide you with some basic guidance on using Git/GitHub, including how to work on branches and submit pull requests.
- Installing SCT for development: If your changes require more in-depth debugging or testing, you can follow this page to prepare your working environment for development on SCT. Otherwise, feel free to submit your changes directly from GitHub.
Cheers, and happy coding!
- Contributing
-
Programming
- API code vs CLI code
- Argparse usage in CLI scripts
- CLI script structure
- Commenting
- Exceptions
- General guidelines
- Logging
- Moving away from pyplot
- Moving away from sct.run and run_proc
- Naming conventions (variables, files)
- QC Reports
- Shell scripts
- Single or double quotes
- Time Profiling and Memory Tracing
- Useful file tools in Python
- Documentation
- Testing
- Packaging
- Websites
- DL models