Merge pull request #277 from lukaszstolarczuk/pr-template

Add Pull Request template

Author: bratpiorka

.github/pull_request_template.md

@@ -0,0 +1,37 @@
+<!-- Provide a short summary of your changes in the Title above -->
+
+### Description
+<!--
+Describe your changes in detail.
+For contribution process guide, look into CONTRIBUTING.md in the main directory
+
+Remember: one PR should fix or enhance one thing.
+    Consider splitting large PR into a few smaller PRs.
+
+If this is a relatively **large or complex** change:
+ - BEFORE creating a PR, try finding an existing issue or start a new discussion,
+ - if the discussion is concluded, go ahead with this PR,
+ - perhaps describe what alternatives you considered.
+
+If this PR references or fixes an open issue, please link it here
+    using "Ref. #<number>" or "Fixes: #<number>".
+-->
+
+### Checklist
+<!--
+Put an 'x' in the boxes that are checked.
+Before checking all the boxes please mark the PR as draft.
+-->
+
+- [ ] Code compiles without errors locally
+- [ ] All tests pass locally
+- [ ] CI workflows execute properly
+<!-- If you have more tasks to do before merging this PR, simply add them here -->
+
+<!-- You can remove these entries, if they don't apply -->
+- [ ] CI workflows, not executed per PR (e.g. Nightly), execute properly <!-- this can be checked, e.g., on your fork -->
+- [ ] New tests added, especially if they will fail without my changes
+- [ ] Added/extended example(s) to cover this functionality
+- [ ] Extended the README/documentation
+- [ ] All newly added source files have a license
+- [ ] All newly added source files are referenced in CMake files

CONTRIBUTING.md

@@ -29,11 +29,19 @@ the proposed types, just pick a general issue with no template.
 
 ## Submitting Pull Requests
 
-We take outside code contributions to UMF through GitHub pull requests.
+We take all code contributions to UMF through GitHub Pull Requests.
 You must first create your own fork of the project and submit your changes to a branch.
 You can then raise a Pull Request targeting `oneapi-src/unified-memory-framework:main`.
-Please try to keep commits neat and in order - please squash your commits to
-include only relevant ones (no "fixes after review" or similar).
+
+When opening a new Pull Request, you'll be provided with a simple template
+to follow with the basic requirements for your changes to fulfill.
+
+A good practices, when opening a PR, are:
+ - one PR should fix/enhance one thing, split large PR into a few smaller PRs,
+ - keep commits neat and in order,
+ - squash commits to include only relevant ones (no "fixes after review" or similar),
+ - if a commit fixes an open issue, add in the commit message line: `Fixes #<issue_no>`
+ - if a commit only mention an open issue, add in the commit message, e.g. `Ref. #<issue_no>`
 
 ### Building and testing