|
1 | | -_Thank you for contributing to ADDA. Please remove the Italic text (`_..._`) throughout this template after following the corresponding instructions_ |
| 1 | +<!--Thank you for contributing to ADDA. The following contains the instructions in the comments. You may remove or leave them.--> |
2 | 2 |
|
3 | | -### Description |
4 | | -_Please explain the changes you made here. Answer both why and what_ |
| 3 | +<!--The following is a general template for changes to the main source code of ADDA. There are a few simpler ones for other cases, listed below. Click them in the preview mode. If proceeding with a general template, please remove this list.--> |
| 4 | + |
| 5 | +### _Simpler specialized templates (click or remove)_ |
| 6 | +- [Miscellaneous tools](?quick_pull=1?template=misc.md) |
| 7 | +- [Examples](?quick_pull=1?template=example.md) |
| 8 | + |
| 9 | +### Summary |
| 10 | + |
| 11 | +<!--Briefly describe the new feature(s), enhancement(s), or bugfix(es) included in this pull request.--> |
5 | 12 |
|
6 | 13 | ### Related issues |
7 | | -_Any nontrivial pull request should first be discussed in the issue_ |
8 | 14 |
|
9 | | -Fixes #... or Related to #... |
| 15 | +<!--Any nontrivial pull request should first be discussed in the issue. If such issue exists, please mention the issue number here as `related to #...`. Also refer to issues, which discuss possible implementation options, if you chose one of them. Use the phrases `fixes #...` or `closes #...`, when you want an issue to be automatically closed when the pull request is merged.--> |
10 | 16 |
|
11 | 17 | ### Types of changes |
12 | | -_What types of changes does your code introduce to ADDA? Put an `x` in the boxes that apply_ |
| 18 | + |
| 19 | +<!--What types of changes does your code introduce to ADDA? Put an `x` in the boxes that apply.--> |
13 | 20 |
|
14 | 21 | - [ ] Bugfix (non-breaking change which fixes an issue) |
15 | | -- [ ] New feature (non-breaking change which adds functionality) |
| 22 | +- [ ] New feature (non-breaking change which adds or improves functionality) |
16 | 23 | - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) |
17 | 24 |
|
| 25 | +### Implementation notes |
| 26 | + |
| 27 | +<!--Provide any relevant details about how the changes are implemented, how correctness was verified, how other features - if any - are affected. If this is a relatively large or complex change, explain why you chose the solution you did and what alternatives you considered. If that was discussed in issue or somewhere else, refer to it here.--> |
| 28 | + |
18 | 29 | ### Checklist |
19 | | -_Put an `x` in the boxes that apply. Typically, all boxes need to be checked before the final merge, but you can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. If you think that some of them are not relevant, discuss this below._ |
| 30 | +<!--Put an `x` in the boxes that apply. Typically, all boxes need to be checked before the final merge, but you can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. If you think that some of them are not relevant, discuss this above.--> |
20 | 31 |
|
21 | | -- [ ] I have read the [contributing guidelines](https://github.com/adda-team/adda/wiki/InstructionCommitters) |
| 32 | +- [ ] I have read the [contributing guidelines](https://github.com/adda-team/adda/wiki/InstructionCommitters). |
22 | 33 | - [ ] The new code complies with the existing [code style](https://github.com/adda-team/adda/wiki/CodeStyleGuide). |
23 | | -- [ ] The code compiles correctly in all relevant regimes (at least, `make seq`) |
| 34 | +- [ ] The code compiles correctly in all relevant regimes (at least, `make seq`). |
24 | 35 | - [ ] The new code does not rely on any Fortran or C++ sources or is disabled by `NO_FORTRAN` or `NO_CPP` preprocessor macros, respectively. |
25 | 36 | - [ ] The change neither adds or removes files; otherwise, these changes are reflected in `README.md` in corresponding folders. |
26 | | -- [ ] No warnings appear during debug compilation (at least, `make seq OPTIONS=DEBUG`, but better `devtools/build_debug`) or they are discussed below |
27 | | -- [ ] Tests pass locally with my changes (at least, `sh comp2exec seq` in `tests/2exec`, but better `devtools/test_new [seq]`). If any errors appear, they are discussed below. |
| 37 | +- [ ] No warnings appear during debug compilation (at least, `make seq OPTIONS=DEBUG`, but better `devtools/build_debug`) or they are discussed above. |
| 38 | +- [ ] Tests pass locally with my changes (at least, `sh comp2exec seq` in `tests/2exec`, but better `devtools/test_new [seq]`). If any errors appear, they are discussed above. |
28 | 39 | - [ ] I have added tests that prove my fix is effective or that my feature works. And these tests pass. This includes new command line in suite files in `tests/2exec` (and potentially new ignore patterns). In some cases, it is desirable to add new tests to `tests/equiv`. |
29 | 40 | - [ ] I have added/extended necessary documentation (if appropriate). If suggesting changes to the manual, I have used "Track changes" in the doc file. |
30 | 41 | - [ ] I have looked through all changes introduced by this pull request (line by line), using `git diff` or, better, some GUI tool, to ensure that no unexpected changes are introduced. |
31 | 42 |
|
32 | | -### Further comments |
33 | | -_If this is a relatively large or complex change, explain why you chose the solution you did and what alternatives you considered. |
34 | | -If that was discussed in issue or somewhere else, refer to it here_ |
|
0 commit comments