Thank you for contributing to the IPFX, your work and time will help to advance open science!
Give a brief overview of the issue you are solving. Succinctly explain the GitHub issue you are addressing and the underlying problem of the ticket. The commit header and body should also include this message, for good commit messages see the contribution guidelines.
Add a link to the issue on Github board example: Addresses issue #1234
- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing functionality to not work as expected)
- Documentation Change
Outline your solution to the previously described issue and underlying cause. This section should include a brief description of your proposed solution and how it addresses the cause of the ticket
Include a bulleted list or check box list of the implemented changes in brief, as well as the addition of supplementary materials (unit tests, integration tests, etc
Describe how you have validated that your solution addresses the root cause of the ticket. What have you done to ensure that your addition is bug free and works as expected? Please provide specific instructions so we can reproduce and list any relevant details about your configuration
- My code follows Allen Institute Contribution Guidelines
- My code is unit tested and does not decrease test coverage
- I have performed a self review of my own code
- My code is well-documented, and the docstrings conform to Numpy Standards
- I have updated the documentation of the repository where appropriate
- The header on my commit includes the issue number
- My code passes all tests
- I have updated the CHANGELOG.md with the description of changes understandable by end users
Use this section to add anything you think worth mentioning to the reader of the issue