Docs

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,17 +1,17 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,15 +24,17 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
+
+**Mobile phone (please complete the following information):**
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,10 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 **Is your feature request related to a problem? Please describe.**

.github/pull_request_template.md

@@ -6,7 +6,7 @@
 
 ## Checklist
 
-* [ ] My code builds correctly.
-* [ ] I have tested my changes.
+- [ ] My code builds correctly.
+- [ ] I have tested my changes.
 
 ## Additional notes

.github/settings.yml

@@ -1,5 +1,4 @@
 ---
-
 repository:
   name: make
   description: Makefiles abstracting some common tasks
@@ -28,14 +27,14 @@ branches:
         dismiss_stale_reviews: true
         require_code_owner_reviews: true
         dismissal_restrictions:
-          users: [ ]
-          teams: [ ]
+          users: []
+          teams: []
       required_status_checks:
         strict: true
-        contexts: [ ]
+        contexts: []
       enforce_admins: false
       required_linear_history: true
       restrictions:
-        apps: [ ]
-        users: [ ]
-        teams: [ ]
+        apps: []
+        users: []
+        teams: []

.github/workflows/linting.yaml

@@ -0,0 +1,23 @@
+---
+name: Lint
+on:
+  push: null
+permissions:
+  contents: read
+jobs:
+  build:
+    name: Lint
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: read
+      statuses: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Super-linter
+        uses: super-linter/super-linter@v7
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/git-release.yaml → .github/workflows/release.yaml

@@ -1,3 +1,4 @@
+name: Release
 on:
   release:
     types:
@@ -7,7 +8,7 @@ permissions:
 jobs:
   release:
     runs-on: ubuntu-latest
-    steps:  
+    steps:
       - uses: actions/checkout@v4
       - uses: applicreation/versions-action@v2
         id: versions

CODE_OF_CONDUCT.md

@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
+- Focusing on what is best not just for us as individuals, but for the
   overall community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
+- The use of sexualized language or imagery, and sexual attention or
   advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
   address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
@@ -52,7 +52,7 @@ decisions when appropriate.
 
 This Code of Conduct applies within all community spaces, and also applies when
 an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
+Examples of representing our community include using an official email address,
 posting via an official social media account, or acting as an appointed
 representative at an online or offline event.
 
@@ -106,23 +106,19 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within
 the community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
+version 2.0, available [here](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
 
 Community Impact Guidelines were inspired by [Mozilla's code of conduct
 enforcement ladder](https://github.com/mozilla/diversity).
 
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.
+For answers to common questions about this code of conduct, see the [FAQ](https://www.contributor-covenant.org/faq).
+Translations are available [here](https://www.contributor-covenant.org/translations).

CONTRIBUTING.md

@@ -6,49 +6,49 @@ Here's how you can contribute:
 
 ## Ways to contribute
 
-* **Reporting Bugs:** If you find a bug, please open a new issue on GitHub. Be sure to include clear steps to reproduce the bug, your environment (operating system, software versions, etc.), and any relevant error messages.
-* **Suggesting Enhancements:** Have an idea for a new feature or improvement? Feel free to open an issue to discuss it. Please provide as much detail as possible about your suggestion and its potential benefits.
-* **Submitting Pull Requests:** If you've fixed a bug or implemented a new feature, you can submit a pull request (PR). Please follow these guidelines:
-    * **Fork the repository** to your own GitHub account.
-    * **Create a new branch** for your changes. Give it a descriptive name (e.g., `fix-typo`, `add-new-feature`).
-    * **Make your changes** following the project's coding style and conventions.
-    * **Write clear and concise commit messages.** Each commit should address a single logical change.
-    * **Test your changes thoroughly.** Ensure that your changes don't introduce new issues and that existing tests still pass. If applicable, add new tests to cover your changes.
-    * **Keep your pull request focused.** If you have multiple unrelated changes, please submit separate PRs.
-    * **Ensure your branch is up-to-date** with the main repository's `main` (or `master`) branch before submitting your PR. You can do this by rebasing your branch onto the latest `main`.
-    * **Clearly describe your changes** in the pull request description. Explain the problem your PR solves or the feature it adds.
-* **Improving Documentation:** Help us make the project more accessible by improving the documentation. This could include fixing typos, clarifying explanations, adding examples, or creating new documentation. You can submit documentation changes via pull requests.
+- **Reporting Bugs:** If you find a bug, please open a new issue on GitHub. Be sure to include clear steps to reproduce the bug, your environment (operating system, software versions, etc.), and any relevant error messages.
+- **Suggesting Enhancements:** Have an idea for a new feature or improvement? Feel free to open an issue to discuss it. Please provide as much detail as possible about your suggestion and its potential benefits.
+- **Submitting Pull Requests:** If you've fixed a bug or implemented a new feature, you can submit a pull request (PR). Please follow these guidelines:
+  - **Fork the repository** to your own GitHub account.
+  - **Create a new branch** for your changes. Give it a descriptive name (e.g., `fix-typo`, `add-new-feature`).
+  - **Make your changes** following the project's coding style and conventions.
+  - **Write clear and concise commit messages.** Each commit should address a single logical change.
+  - **Test your changes thoroughly.** Ensure that your changes don't introduce new issues and that existing tests still pass. If applicable, add new tests to cover your changes.
+  - **Keep your pull request focused.** If you have multiple unrelated changes, please submit separate PRs.
+  - **Ensure your branch is up-to-date** with the main repository's `main` (or `master`) branch before submitting your PR. You can do this by rebasing your branch onto the latest `main`.
+  - **Clearly describe your changes** in the pull request description. Explain the problem your PR solves or the feature it adds.
+- **Improving Documentation:** Help us make the project more accessible by improving the documentation. This could include fixing typos, clarifying explanations, adding examples, or creating new documentation. You can submit documentation changes via pull requests.
 
 ## Code of conduct
 
 Please review and adhere to our [Code of Conduct](./CODE_OF_CONDUCT.md) in all your interactions with the project and its community.
 
 ## Getting started
 
-* **Fork the repository** on GitHub.
-* **Clone your fork** to your local machine:
-    ```bash
-    git clone [https://github.com/daemon-solutions/make.git](https://github.com/daemon-solutions/make.git)
-    cd REPOSITORY_NAME
-    ```
-* **Set up your development environment** according to the project's instructions (if any).
-* **Create a new branch** for your work:
-    ```bash
-    git checkout -b your-branch-name
-    ```
+- **Fork the repository** on GitHub.
+- **Clone your fork** to your local machine:
+  ```bash
+  git clone [https://github.com/daemon-solutions/make.git](https://github.com/daemon-solutions/make.git)
+  cd REPOSITORY_NAME
+  ```
+- **Set up your development environment** according to the project's instructions (if any).
+- **Create a new branch** for your work:
+  ```bash
+  git checkout -b your-branch-name
+  ```
 
 ## Submitting a pull request
 
-1.  **Make your changes** and commit them:
-    ```bash
-    git add .
-    git commit -m "Your descriptive commit message"
-    ```
-2.  **Push your branch** to your fork on GitHub:
-    ```bash
-    git push origin your-branch-name
-    ```
-3.  **Open a pull request** on the main repository's GitHub page.
+1. **Make your changes** and commit them:
+   ```bash
+   git add .
+   git commit -m "Your descriptive commit message"
+   ```
+2. **Push your branch** to your fork on GitHub:
+   ```bash
+   git push origin your-branch-name
+   ```
+3. **Open a pull request** on the main repository's GitHub page.
 
 ## Questions and support
 

README.md

@@ -9,29 +9,17 @@ These files are created to abstract common tasks and are designed to be used pri
 The primary prerequisite is to have [Docker Desktop](https://www.docker.com/products/docker-desktop/) (or just Docker) installed.  
 As much as possible is done via Docker to prevent individuals from having to install multiple applications or libraries as well as worrying about what versions are needed.
 
-In the event other applications are needed (i.e. git) you will receive an error if they are not installed.
+In the event other applications are needed (i.e. Git) you will receive an error if they are not installed.
 
 ## Usage
 
 ### Makefile
 
 #### Setup
 
-To use these files within your repository, you can copy and paste the following code to the top of your repository `Makefile`.  
+To use these files within your repository, you can copy and paste the code from [init.mk](./examples/init.mk) to the top of your repository `Makefile`.  
 Alternatively, you can write a custom adaptation to replicate the same functionality.
 
-```makefile
-ROOT_DIR := $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
-MAKE_DIR := $(ROOT_DIR)/.make
-
-init: MAKE_URI = https://raw.githubusercontent.com/daemon-solutions/make
-init: MAKE_VERSION = v0
-init: MAKE_FILES = terraform
-init:
-	@rm -rf $(MAKE_DIR) && mkdir -p $(MAKE_DIR)
-	@for MAKE_FILE in $(MAKE_FILES); do docker run --rm curlimages/curl -sSL $(MAKE_URI)/$(MAKE_VERSION)/src/$${MAKE_FILE}.mk > $(MAKE_DIR)/$${MAKE_FILE}.mk; done
-```
-
 Files can then be included into your repository folder specific Makefiles, as needed.
 
 #### Target/rule
@@ -46,7 +34,7 @@ It is also recommended ignoring the directory from your repository by adding `.m
 
 #### Version
 
-These files are versioned and follow [semantic versioning](https://semver.org/) which is achieved with git tags, 
+These files are versioned and follow [semantic versioning](https://semver.org/) which is achieved with Git tags,
 each patch version is immutable and will never change while the minor and major tags are mutable and will move based on the relevant patch version.  
 It is recommended to lock your `MAKE_VERSION` to the current major version.