Thank you for your interest in making this library better! The following is a set of guidelines for contributing to the AxionFileLoader library. These guidelines help us streamline feature requests, bug reports, code contributions, and pull requests. For general questions, please consult the [Wiki] or contact us at support@axionbio.com.
Please use the issues section of this repository to submit any bugs, suggestions, or feedback. For all issues, please include as much detail as possible and use a descriptive title.
Before submitting a issue:
- Please make sure all relevant scripts are in your Current Directory or Path.
- Please make sure that .raw or .spk files are in an accessible directory.
- Check that your issue has not already been reported: ADD LINK HERE
For a bug, please include:
- A detailed description
- Exact, explicit steps to reproduce (include command line calls, screenshots, or gifs as needed)
- Expected behavior versus actual behavior
- Matlab version
For a feature request or general feedback, please include:
- A detailed description
- Desired inputs (file types or data types)
- Desired outputs (plots, metrics, etc.)
- Application/Scientific question
- Any relevant publications or resources
This library uses Pull Requests for all changes.
Before proposing a change or opening a pull request, please open an issue to discuss it with the maintaners.
When proposing changes, please thoroughly comment your code and include any sample files that might be helpful.
We look forward to growing together!