Merge pull request #366 from lukaszstolarczuk/minor-docs-updates

Minor docs updates

Author: lplewa

.github/docker/README.md

@@ -12,7 +12,7 @@ simply replace word `docker` with `podman`.
 To build docker image on local machine enter the root dir of the repository and execute:
 
 ```sh
-docker build -t ur:ubuntu-22.04 -f .github/docker/ubuntu-22.04.Dockerfile .
+docker build -t umf:ubuntu-22.04 -f .github/docker/ubuntu-22.04.Dockerfile .
 ```
 
 To set any build time variable (e.g., an optional ARG from docker recipe), add to the command (after `build`), e.g.:
@@ -33,7 +33,7 @@ One other example of using these extra build arguments are proxy settings. They
 To run docker container (using the previously built image) execute:
 
 ```sh
-docker run --shm-size=4G -v /your/workspace/path/:/opt/workspace:z -w /opt/workspace/ -it ur:ubuntu-22.04 /bin/bash
+docker run --shm-size=4G -v /your/workspace/path/:/opt/workspace:z -w /opt/workspace/ -it umf:ubuntu-22.04 /bin/bash
 ```
 
 To set (or override) any docker environment variable, add to the command (after `run`):

.github/pull_request_template.md

@@ -35,3 +35,4 @@ Before checking all the boxes please mark the PR as draft.
 - [ ] Extended the README/documentation
 - [ ] All newly added source files have a license
 - [ ] All newly added source files are referenced in CMake files
+- [ ] Logger (with debug/info/... messages) is used

CONTRIBUTING.md

@@ -40,8 +40,8 @@ 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>`
+ - 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
 

README.md

@@ -138,7 +138,8 @@ A memory provider that provides memory from L0 device.
 1) Linux or Windows OS
 2) The `UMF_BUILD_LEVEL_ZERO_PROVIDER` option turned `ON` (by default)
 
-Additionally, required for tests: 
+Additionally, required for tests:
+
 3) Linux OS
 4) The `UMF_BUILD_GPU_TESTS` option turned `ON`
 5) System with Level Zero compatible GPU