|
1 | | -# I found a bug |
| 1 | +# I Found a Bug |
| 2 | + |
| 3 | +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. |
| 4 | + |
| 5 | +## NiWrap Issues (Most Common) |
| 6 | + |
| 7 | +Most issues are related to specific neuroimaging tools or wrapper functions. For these, please use the **NiWrap issue tracker**: |
| 8 | + |
| 9 | +**🔗 [Report NiWrap Issues](https://github.com/styx-api/niwrap/issues)** |
| 10 | + |
| 11 | +This includes: |
| 12 | +- Problems with specific tools (FSL, AFNI, ANTs, etc.) |
| 13 | +- Missing or incorrect wrapper functions |
| 14 | +- Tool-specific errors or unexpected behavior |
| 15 | +- Requests for new neuroimaging tools |
| 16 | + |
| 17 | +The NiWrap repository has helpful issue templates to guide you: |
| 18 | +- 🐛 **Report Problem with Tool** - For bugs with specific interfaces |
| 19 | +- ✨ **Request New Tool** - For missing tools or packages |
| 20 | +- ❓ **Question** - For general questions about usage |
| 21 | +- 🙋♂️ **Help Request** - When you need assistance |
| 22 | + |
| 23 | +## Styx Core Issues |
| 24 | + |
| 25 | +For problems with the core Styx framework (runners, file handling, etc.): |
| 26 | + |
| 27 | +**🔗 [Report Styx Core Issues](https://github.com/styx-api/styx/issues)** |
| 28 | + |
| 29 | +This includes: |
| 30 | +- Problems with runners (LocalRunner, DockerRunner, etc.) |
| 31 | +- File I/O issues |
| 32 | +- Core framework bugs |
| 33 | +- Performance problems |
| 34 | + |
| 35 | +## Documentation Issues |
| 36 | + |
| 37 | +Found a problem with this documentation or have suggestions for improvement? |
| 38 | + |
| 39 | +**🔗 [Report Documentation Issues](https://github.com/styx-api/styxbook/issues)** |
| 40 | + |
| 41 | +This includes: |
| 42 | +- Typos, unclear explanations, or missing information |
| 43 | +- Broken links or formatting issues |
| 44 | +- Suggestions for new documentation topics |
| 45 | +- Examples that don't work as expected |
| 46 | + |
| 47 | +## Before Reporting |
| 48 | + |
| 49 | +To get you help faster: |
| 50 | + |
| 51 | +1. **Check existing issues** - Someone might have already reported the same problem |
| 52 | +2. **Include details** - Error messages, code examples, and your environment details are super helpful |
| 53 | +3. **Use the templates** - They guide you through providing the right information |
| 54 | + |
| 55 | +Thanks for helping make Styx better! 🎉 |
0 commit comments