|
1 | | -# A clear and descriptive title (No issue numbers please) |
| 1 | +Thank you for your contribution! |
| 2 | +If you have any questions about your PR, or need help completing it, you can ping the maintainers of this repository, who will be happy to help if they can find time. |
2 | 3 |
|
3 | | -> _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_ :smile:. _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._ |
4 | | -
|
5 | | -## Types of changes |
6 | | - |
7 | | -This PR implements the following changes: |
8 | | -_(Please tick any or all of the following that are applicable)_ |
9 | | - |
10 | | -* [ ] :sparkles: New feature (A non-breaking change which adds functionality). |
11 | | -* [ ] :bug: Bug fix (A non-breaking change, which fixes an issue). |
12 | | -* [ ] :boom: Breaking change (fix or feature that would cause existing functionality to change). |
13 | | - |
14 | | -## :clipboard: Additional detail |
15 | | - |
16 | | -- If you have implemented new features or behaviour |
17 | | - - **Provide a description of the addition** in as many details as possible. |
18 | | - |
19 | | - - **Provide justification of the addition**. |
20 | | - |
21 | | - - **Provide a runnable example of use of your addition**. This lets reviewers |
22 | | - and others try out the feature before it is merged or makes it's way to release. |
23 | | - |
24 | | -- If you have changed current behaviour... |
25 | | - - **Describe the behaviour prior to you changes** |
26 | | - |
27 | | - - **Describe the behaviour after your changes** and justify why you have made the changes, |
28 | | - Please describe any breakages you anticipate as a result of these changes. |
29 | | - |
30 | | - - **Does your change alter APIs or existing exposed methods/types?** |
31 | | - If so, this may cause dependency issues and breakages, so the maintainer |
32 | | - will need to consider this when versioning the next release. |
33 | | - |
34 | | - - If you are implementing changes that are intended to increase performance, you |
35 | | - should provide the results of a simple performance benchmark exercise |
36 | | - demonstrating the improvement. Especially if the changes make code less legible. |
37 | | - |
38 | | -## :ballot_box_with_check: Checklist |
39 | | - |
40 | | -- [ ] :art: The changes implemented is consistent with the [julia style guide](https://docs.julialang.org/en/stable/manual/style-guide/). |
41 | | -- [ ] :blue_book: I have updated and added relevant docstrings, in a manner consistent with the [documentation styleguide](https://docs.julialang.org/en/stable/manual/documentation/). |
42 | | -- [ ] :blue_book: I have added or updated relevant user and developer manuals/documentation in `docs/src/`. |
43 | | -- [ ] :ok: There are unit tests that cover the code changes I have made. |
44 | | -- [ ] :ok: The unit tests cover my code changes AND they pass. |
45 | | -- [ ] :pencil: I have added an entry to the `[UNRELEASED]` section of the manually curated `CHANGELOG.md` file for this repository. |
46 | | -- [ ] :ok: All changes should be compatible with the latest stable version of Julia. |
47 | | -- [ ] :thought_balloon: I have commented liberally for any complex pieces of internal code. |
| 4 | +You can optionally use the following checklist when you work on your PR: |
| 5 | +- [ ] I have updated any relevant documentation and docstrings. |
| 6 | +- [ ] I have added unit tests, and the CodeCov bot shows tests cover my new code. |
| 7 | +- [ ] I have mentioned my changes in the CHANGELOG.md file. |
0 commit comments