2.7 KiB
A clear and descriptive title (No issue numbers please)
This template is rather extensive. Fill out all that you can, if are a new contributor or you're unsure about any section, leave it unchanged and a reviewer will help you 😄. This template is simply a tool to help everyone remember the BioJulia guidelines, if you feel anything in this template is not relevant, simply delete it.
Types of changes
This PR implements the following changes: (Please tick any or all of the following that are applicable)
- ✨ New feature (A non-breaking change which adds functionality).
- 🐛 Bug fix (A non-breaking change, which fixes an issue).
- 💥 Breaking change (fix or feature that would cause existing functionality to change).
📋 Additional detail
-
If you have implemented new features or behaviour
-
Provide a description of the addition in as many details as possible.
-
Provide justification of the addition.
-
Provide a runnable example of use of your addition. This lets reviewers and others try out the feature before it is merged or makes it's way to release.
-
-
If you have changed current behaviour...
-
Describe the behaviour prior to you changes
-
Describe the behaviour after your changes and justify why you have made the changes, Please describe any breakages you anticipate as a result of these changes.
-
Does your change alter APIs or existing exposed methods/types? If so, this may cause dependency issues and breakages, so the maintainer will need to consider this when versioning the next release.
-
If you are implementing changes that are intended to increase performance, you should provide the results of a simple performance benchmark exercise demonstrating the improvement. Especially if the changes make code less legible.
-
☑️ Checklist
- 🎨 The changes implemented is consistent with the julia style guide.
- 📘 I have updated and added relevant docstrings, in a manner consistent with the documentation styleguide.
- 📘 I have added or updated relevant user and developer manuals/documentation in
docs/src/. - 🆗 There are unit tests that cover the code changes I have made.
- 🆗 The unit tests cover my code changes AND they pass.
- 📝 I have added an entry to the
[UNRELEASED]section of the manually curatedCHANGELOG.mdfile for this repository. - 🆗 All changes should be compatible with the latest stable version of Julia.
- 💭 I have commented liberally for any complex pieces of internal code.