I Found a Bug

If you've encountered a problem, we'd love to help! The best place to report issues depends on what you're having trouble with.

NiWrap Issues (Most Common)

Most issues are related to specific neuroimaging tools or wrapper functions. For these, please use the NiWrap issue tracker:

🔗 Report NiWrap Issues

This includes:

  • Problems with specific tools (FSL, AFNI, ANTs, etc.)
  • Missing or incorrect wrapper functions
  • Tool-specific errors or unexpected behavior
  • Requests for new neuroimaging tools

The NiWrap repository has helpful issue templates to guide you:

  • 🐛 Report Problem with Tool - For bugs with specific interfaces
  • ✨ Request New Tool - For missing tools or packages
  • ❓ Question - For general questions about usage
  • 🙋‍♂️ Help Request - When you need assistance

Styx Core Issues

For problems with the core Styx framework (runners, file handling, etc.):

🔗 Report Styx Core Issues

This includes:

  • Problems with runners (LocalRunner, DockerRunner, etc.)
  • File I/O issues
  • Core framework bugs
  • Performance problems

Documentation Issues

Found a problem with this documentation or have suggestions for improvement?

🔗 Report Documentation Issues

This includes:

  • Typos, unclear explanations, or missing information
  • Broken links or formatting issues
  • Suggestions for new documentation topics
  • Examples that don't work as expected

Before Reporting

To get you help faster:

  1. Check existing issues - Someone might have already reported the same problem
  2. Include details - Error messages, code examples, and your environment details are super helpful
  3. Use the templates - They guide you through providing the right information

Thanks for helping make Styx better! 🎉