Commit bae5527
Adds PR template (arrayfire#2929)
* Adds PR template
**Short description of change**
Adds a github PR template for the ArrayFire project. Developers will now face a short suggested checklist when creating a new PR on github.
**Motivation**
Adding a PR template will make it easier to reference old issues when generating reports and link future issue in historical context.
**Future considerations**
Wiki might need to be updated with additional development guidelines. The current guidelines could be more comprehensive.
* Updated pull request template
* Added additional detail.
* Use comments instead of text to communicate with the reader.
* Create a simple checklist
* Grammer + Future changes in the description section
Co-authored-by: Umar Arshad <umar@arrayfire.com>1 parent aaa948e commit bae5527
1 file changed
Lines changed: 40 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,40 @@ | |||
| 1 | + | ||
| 2 | + <!-- | ||
| 3 | + Short description of change | ||
| 4 | + | ||
| 5 | + This should be one or two sentences that describe the overall | ||
| 6 | + motivation of the PR. Description of what was done for an unfamiliar | ||
| 7 | + reviewer. | ||
| 8 | + --> | ||
| 9 | + | ||
| 10 | + Description | ||
| 11 | + ----------- | ||
| 12 | + <!-- | ||
| 13 | + Additional information about the PR answering following questions: | ||
| 14 | + | ||
| 15 | + * Is this a new feature or a bug fix? | ||
| 16 | + * More detail if necessary to describe all commits in pull request. | ||
| 17 | + * Why these changes are necessary. | ||
| 18 | + * Potential impact on specific hardware, software or backends. | ||
| 19 | + * New functions and their functionallity. | ||
| 20 | + * Can this PR be backported to older versions? | ||
| 21 | + * Future changes not implemented in this PR. | ||
| 22 | + --> | ||
| 23 | + Fixes: #<issue number> ... | ||
| 24 | + | ||
| 25 | + Changes to Users | ||
| 26 | + ---------------- | ||
| 27 | + <!-- | ||
| 28 | + * Additional options added to the build. | ||
| 29 | + * What changes will existing users have to make to their code or build steps? | ||
| 30 | + Refer to [wiki](https://github.com/arrayfire/arrayfire/wiki) for development guidelines | ||
| 31 | + --> | ||
| 32 | + | ||
| 33 | + Checklist | ||
| 34 | + --------- | ||
| 35 | + <!-- Check if done or not applicable --> | ||
| 36 | + - [ ] Rebased on latest master | ||
| 37 | + - [ ] Code compiles | ||
| 38 | + - [ ] Tests pass | ||
| 39 | + - [ ] Functions added to unified API | ||
| 40 | + - [ ] Functions documented | ||
0 commit comments