Merge pull request #107 from MonolithProjects/develop

Minor changes

Author: MonolithProjects

.github/CONTRIBUTING.md

@@ -15,11 +15,14 @@ When you see some issue or have an idea for improvement, [create an issue](https
 
 Click on `fork` on the top-right corner and fork the repository.
 
-## 3. Make the changes
+## 3. Install pre-commit
 
-Do dthe changes in your own GitHub namespace.
+Install [Pre-commit](https://pre-commit.com/#install) software
+## 4. Make the changes
 
-## 4. Test the changes
+Do the changes in your own GitHub namespace.
+
+## 5. Test the changes
 
 **Note:** I will test the role again, so you don't need to do that if you don't want to.
 
@@ -33,8 +36,8 @@ molecule test
 
 > You will need to edit the files in `molecule/default` directory (please do not commit those changes)
 
-## 5. Create a pull request
+## 6. Create a pull request
 
 Please create a pull request into the `develop` branch. Here is [how to do it](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).
 
-Please consider to [sponsor](https://github.com/sponsors/monolithprojects) me :-)
+Please consider to [sponsor](https://github.com/sponsors/monolithprojects) me :-)

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,22 +1,19 @@
-# Pull Request Template
-
-## Description
+# Description
 
 Please include a summary of the change and which issue is fixed.
 
 ## Type of change
 
-Please delete options that are not relevant.
-
 - [ ] Bug fix (non-breaking change which fixes an issue)
 - [ ] New feature (non-breaking change which adds functionality)
 - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
 - [ ] This change requires a documentation update
+- [ ] Minor change (pipeline, tests, spelling ...)
 
 ## How Has This Been Tested?
 
 Please describe the tests that you ran to verify your changes.
 
 ## Destination branch
 
-Create a PR into `develop` branch
+Create a PR into `develop` branch

.pre-commit-config.yaml

@@ -6,3 +6,17 @@ repos:
           args: [--allow-multiple-documents]
         - id: end-of-file-fixer
         - id: trailing-whitespace
+
+    - repo: https://github.com/adrienverge/yamllint
+      rev: v1.26.3
+      hooks:
+        - id: yamllint
+          args: [-c=.yamllint]
+
+    - repo: https://github.com/robertdebock/pre-commit
+      rev: v1.2.3
+      hooks:
+        - id: ansible_role_find_unused_variable
+        - id: ansible_role_find_empty_files
+        - id: ansible_role_find_empty_directories
+        - id: ansible_role_fix_readability

README.md

@@ -96,7 +96,7 @@ runner_name: "{{ ansible_hostname }}"
 # Will the runner be deployed on Github Enterprise server?
 runner_on_ghes: no
 
-# Custom service name when usign Github Enterprise server
+# Custom service name when using Github Enterprise server
 # DEPRECATED: this variable is deprecated in favor of "runner_on_ghes" and will be removed in release 1.15.
 # service_name: actions.runner._services.{{ runner_name }}.service
 

defaults/main.yml

@@ -47,7 +47,7 @@ runner_name: "{{ ansible_hostname }}"
 # Will the runner be deployed on Github Enterprise server?
 runner_on_ghes: no
 
-# Custom service name when usign Github Enterprise server
+# Custom service name when using Github Enterprise server
 # DEPRECATED: this variable is deprecated in favor of "runner_on_ghes" and will be removed in release 1.15.
 # service_name: actions.runner._services.{{ runner_name }}.service