Skip to content

Commit afd3d18

Browse files
committed
updates main PR template, adds two custom ones
1 parent 3933d65 commit afd3d18

File tree

3 files changed

+108
-15
lines changed

3 files changed

+108
-15
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: Example
3+
about: Submit a pull request related to examples or published results in examples/ folder
4+
title: "[EXAMPLE] _Replace With Suitable Title_"
5+
labels: comp-Example
6+
assignees: ''
7+
8+
---
9+
10+
<!--Thank you for contributing to ADDA. The following contains the instructions in the comments. You may remove or leave them.-->
11+
12+
### Summary
13+
14+
<!--Briefly describe the new example or enhancement/bugfix of existing one in examples/ folder.-->
15+
16+
### Related issues
17+
18+
<!--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 #221` or `closes #135`, when you want an issue to be automatically closed when the pull request is merged.-->
19+
20+
### Types of changes
21+
22+
<!--What types of changes does your code introduce to the example? Put an `x` in the boxes that apply.-->
23+
24+
- [ ] New example
25+
- Existing example:
26+
* [ ] Bugfix (non-breaking change which fixes an issue)
27+
* [ ] New feature (non-breaking change which adds or improves functionality)
28+
29+
### Implementation notes
30+
31+
<!--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.-->
32+
33+
### Checklist
34+
<!--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.-->
35+
36+
- [ ] I have read the [contributing guidelines](https://github.com/adda-team/adda/wiki/InstructionCommitters), including the [dedicated section](https://github.com/adda-team/adda/wiki/InstructionCommitters#examples).
37+
- [ ] The change neither adds or removes files; otherwise, these changes are reflected in `README.md` in corresponding folders.
38+
- [ ] The script(s) run locally with my changes, using default parameters. If any errors appear, they are discussed above.
39+
- [ ] If the script(s) aim to reproduce published figures, I have visually verified the agreement.
40+
- [ ] I have added/extended necessary documentation (if appropriate).
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.
42+
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: Miscellaneous tool
3+
about: Submit a pull request related to tool in misc/ folder
4+
title: "[MISC] _Replace With Suitable Title_"
5+
labels: comp-Misc
6+
assignees: ''
7+
8+
---
9+
10+
<!--Thank you for contributing to ADDA. The following contains the instructions in the comments. You may remove or leave them.-->
11+
12+
### Summary
13+
14+
<!--Briefly describe the new tool or enhancement/bugfix of existing tool in misc/ folder.-->
15+
16+
### Related issues
17+
18+
<!--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 #221` or `closes #135`, when you want an issue to be automatically closed when the pull request is merged.-->
19+
20+
### Types of changes
21+
22+
<!--What types of changes does your code introduce to the tool from misc/? Put an `x` in the boxes that apply.-->
23+
24+
- [ ] New tool
25+
- Existing tool:
26+
* [ ] Bugfix (non-breaking change which fixes an issue)
27+
* [ ] New feature (non-breaking change which adds or improves functionality)
28+
* [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
29+
30+
### Implementation notes
31+
32+
<!--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.-->
33+
34+
### Checklist
35+
<!--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.-->
36+
37+
- [ ] I have read the [contributing guidelines](https://github.com/adda-team/adda/wiki/InstructionCommitters), including the [dedicated section](https://github.com/adda-team/adda/wiki/InstructionCommitters#miscellaneous-tools).
38+
- [ ] If the tool is based on compiled language, it compiles correctly in all relevant regimes.
39+
- [ ] The change neither adds or removes files; otherwise, these changes are reflected in `README.md` in corresponding folders.
40+
- [ ] Tests (examples of usage) are provided and they pass locally with my changes. If any errors appear, they are discussed above.
41+
- [ ] I have added/extended necessary documentation (if appropriate).
42+
- [ ] 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.
43+

.github/pull_request_template.md

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,42 @@
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.-->
22

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.-->
512

613
### Related issues
7-
_Any nontrivial pull request should first be discussed in the issue_
814

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.-->
1016

1117
### 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.-->
1320

1421
- [ ] 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)
1623
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
1724

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+
1829
### 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.-->
2031

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).
2233
- [ ] 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`).
2435
- [ ] The new code does not rely on any Fortran or C++ sources or is disabled by `NO_FORTRAN` or `NO_CPP` preprocessor macros, respectively.
2536
- [ ] 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.
2839
- [ ] 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`.
2940
- [ ] I have added/extended necessary documentation (if appropriate). If suggesting changes to the manual, I have used "Track changes" in the doc file.
3041
- [ ] 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.
3142

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

Comments
 (0)