Apply BestieTemplate v0.10.1

.JuliaFormatter.toml

@@ -0,0 +1,3 @@
+indent = 4
+margin = 92
+normalize_line_endings = "unix"

.copier-answers.yml

@@ -0,0 +1,25 @@
+# Changes here will be overwritten by Copier
+AddAllcontributors: false
+AddCodeOfConduct: true
+AddContributionDocs: false
+AddCopierCI: false
+AddGitHubTemplates: true
+AddMacToCI: true
+AddPrecommit: true
+AddWinToCI: true
+AnswerStrategy: ask
+Authors: Tilman Hinnerichs <[email protected]>
+AutoIncludeTests: true
+CodeOfConductContact: [email protected]
+Indentation: 4
+JuliaMinCIVersion: '1.8'
+JuliaMinVersion: '1.8'
+License: MIT
+LicenseCopyrightHolders: Herb-AI
+PackageName: HerbSpecification
+PackageOwner: Herb-AI
+PackageUUID: 6d54aada-062f-46d8-85cf-a1ceaf058a06
+RunJuliaNightlyOnCI: true
+UseCirrusCI: false
+_commit: v0.10.1
+_src_path: https://github.com/abelsiqueira/BestieTemplate.jl

.editorconfig

@@ -0,0 +1,10 @@
+# https://editorconfig.org
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_size = 4
+indent_style = space
+trim_trailing_whitespace = true

.github/ISSUE_TEMPLATE/10-bug-report.yml

@@ -0,0 +1,63 @@
+name: Bug Report
+description: File a bug report related to running the package
+title: "[Bug] "
+labels: ["bug"]
+body:
+    - type: markdown
+      attributes:
+          value: |
+              Thanks for taking the time to fill out this bug report!
+
+              Please, before submitting, make sure that:
+
+              - There is not an [existing issue](https://github.com/Herb-AI/HerbSpecification.jl/issues) with the same question
+
+
+              - You are following the [code of conduct](https://github.com/Herb-AI/HerbSpecification.jl/blob/main/CODE_OF_CONDUCT.md)
+
+
+              The form below should help you in filling out this issue.
+    - type: textarea
+      id: description
+      attributes:
+          label: Description
+          description: Describe the bug
+      validations:
+          required: true
+    - type: input
+      id: pkg-version
+      attributes:
+          label: Package Version
+          description: What version of the package are you running?
+      validations:
+          required: true
+    - type: input
+      id: version
+      attributes:
+          label: Julia Version
+          description: What version of Julia are you running?
+      validations:
+          required: true
+    - type: textarea
+      id: reproduction
+      attributes:
+          label: Reproduction steps
+          description: What steps led to the bug happening? Please provide a minimal reproducible example.
+      validations:
+          required: true
+    - type: textarea
+      id: logs
+      attributes:
+          label: Relevant log output
+          description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+          render: shell
+    - type: dropdown
+      id: os
+      attributes:
+          label: "Operating System"
+          description: What is the impacted environment?
+          multiple: true
+          options:
+              - Windows
+              - Linux
+              - Mac

.github/ISSUE_TEMPLATE/20-feature-request.yml

@@ -0,0 +1,44 @@
+name: "Feature Request"
+description: Suggest a new feature for the package
+body:
+    - type: markdown
+      attributes:
+          value: |
+              Thanks for taking the time to fill out this feature request!
+
+              Please, before submitting, make sure that:
+
+              - There is not an [existing issue](https://github.com/Herb-AI/HerbSpecification.jl/issues) with the same question
+
+
+              - You are following the [code of conduct](https://github.com/Herb-AI/HerbSpecification.jl/blob/main/CODE_OF_CONDUCT.md)
+
+
+              The form below should help you in filling out this issue.
+    - type: textarea
+      id: description
+      attributes:
+          label: Description
+          description: Describe the requested feature
+      validations:
+          required: true
+    - type: textarea
+      id: validation
+      attributes:
+          label: Validation and testing
+          description: How could we verify that the new feature works? What kind of tests can be done?
+    - type: textarea
+      id: motivation
+      attributes:
+          label: Motivation
+          description: Explain why this feature is relevant
+    - type: textarea
+      id: target
+      attributes:
+          label: Target audience
+          description: Tell more about the users of this feature, or where it could be useful
+    - type: textarea
+      id: can-help
+      attributes:
+          label: Can you help?
+          description: Can you help developing this feature?

.github/ISSUE_TEMPLATE/30-usage.yml

@@ -0,0 +1,26 @@
+name: "Usage question"
+description: Questions related to the usage
+labels: ["documentation"]
+body:
+    - type: markdown
+      attributes:
+          value: |
+              Thanks for taking the time to fill out this question!
+
+              Please, before submitting, make sure that:
+
+              - You have checked the [documentation](https://Herb-AI.github.io/HerbSpecification.jl) and haven't found enough information
+              - There is not an [existing issue](https://github.com/Herb-AI/HerbSpecification.jl/issues) with the same question
+
+
+              - You are following the [code of conduct](https://github.com/Herb-AI/HerbSpecification.jl/blob/main/CODE_OF_CONDUCT.md)
+
+
+              The form below should help you in filling out this issue.
+    - type: textarea
+      id: description
+      attributes:
+          label: Description
+          description: Write your question
+      validations:
+          required: true

.github/ISSUE_TEMPLATE/99-general.yml

@@ -0,0 +1,24 @@
+name: "General issue"
+description: In case none of the others templates apply
+body:
+    - type: markdown
+      attributes:
+          value: |
+              Thanks for taking the time to fill out this issue!
+
+              Please, before submitting, make sure that:
+
+              - There is not an [existing issue](https://github.com/Herb-AI/HerbSpecification.jl/issues) with the same question
+
+
+              - You are following the [code of conduct](https://github.com/Herb-AI/HerbSpecification.jl/blob/main/CODE_OF_CONDUCT.md)
+
+
+              The form below should help you in filling out this issue.
+    - type: textarea
+      id: description
+      attributes:
+          label: Description
+          description: Describe the issue
+      validations:
+          required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+    - name: Discussions
+      url: https://github.com/Herb-AI/HerbSpecification.jl/discussions
+      about: Create and follow discussions here

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,29 @@
+<!--
+Thanks for making a pull request to HerbSpecification.jl.
+We have added this PR template to help you help us.
+
+Make sure to abide by the code of conduct.
+
+See the comments below, fill the required fields, and check the items.
+-->
+
+## Related issues
+
+<!-- We normally work with (i) create issue; (ii) discussion if necessary; (iii) create PR. So, at least one of the following should be true:-->
+
+<!-- Option 1, this closes an existing issue. Fill the number below-->
+Closes #
+
+<!-- Option 2, this is a small fix that arguably won't need an issue. Uncomment below -->
+<!--
+There is no related issue.
+-->
+
+## Checklist
+
+<!-- mark true if NA -->
+<!-- leave PR as draft until all is checked -->
+
+- [ ] Tests are passing
+- [ ] Lint workflow is passing
+- [ ] Docs were updated and workflow is passing

.github/dependabot.yml

@@ -0,0 +1,7 @@
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+version: 2
+updates:
+    - package-ecosystem: "github-actions"
+      directory: "/" # Location of package manifests
+      schedule:
+          interval: "weekly"

.github/workflows/CI.yml

@@ -1,43 +1,42 @@
 name: CI
 on:
-  push:
-    branches:
-      - master
-    tags: ['*']
-  pull_request:
+    push:
+        branches:
+            - master
+        tags: ["*"]
+    pull_request:
 concurrency:
-  # Skip intermediate builds: always.
-  # Cancel intermediate builds: only if it is a pull request build.
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+    # Skip intermediate builds: always.
+    # Cancel intermediate builds: only if it is a pull request build.
+    group: ${{ github.workflow }}-${{ github.ref }}
+    cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
 jobs:
-  test:
-    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        version:
-          - '1.8'
-          - '1'
-          - 'nightly'
-        os:
-          - ubuntu-latest
-        arch:
-          - x64
-    steps:
-      - uses: actions/checkout@v3
-      - uses: julia-actions/setup-julia@v1
-        with:
-          version: ${{ matrix.version }}
-          arch: ${{ matrix.arch }}
-      - uses: julia-actions/cache@v1
-      - uses: julia-actions/julia-buildpkg@v1
-      - uses: julia-actions/julia-runtest@v1
-      - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v4
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          files: lcov.info
-          fail_ci_if_error: false
-
+    test:
+        name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
+        runs-on: ${{ matrix.os }}
+        strategy:
+            fail-fast: false
+            matrix:
+                version:
+                    - "1.8"
+                    - "1"
+                    - "nightly"
+                os:
+                    - ubuntu-latest
+                arch:
+                    - x64
+        steps:
+            - uses: actions/checkout@v3
+            - uses: julia-actions/setup-julia@v1
+              with:
+                  version: ${{ matrix.version }}
+                  arch: ${{ matrix.arch }}
+            - uses: julia-actions/cache@v1
+            - uses: julia-actions/julia-buildpkg@v1
+            - uses: julia-actions/julia-runtest@v1
+            - uses: julia-actions/julia-processcoverage@v1
+            - uses: codecov/codecov-action@v4
+              with:
+                  token: ${{ secrets.CODECOV_TOKEN }}
+                  files: lcov.info
+                  fail_ci_if_error: false

.github/workflows/CompatHelper.yml

@@ -1,16 +1,51 @@
+# CompatHelper v3.5.0
 name: CompatHelper
+
 on:
-  schedule:
-    - cron: 0 0 * * *
-  workflow_dispatch:
+    schedule:
+        - cron: 0 0 * * * # Every day at 00:00 UTC
+    workflow_dispatch:
+
+permissions:
+    contents: write
+    pull-requests: write
+
 jobs:
-  CompatHelper:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Pkg.add("CompatHelper")
-        run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
-      - name: CompatHelper.main()
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
-        run: julia -e 'using CompatHelper; CompatHelper.main()'
+    CompatHelper:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Check if Julia is already available in the PATH
+              id: julia_in_path
+              run: which julia
+              continue-on-error: true
+            - name: Install Julia, but only if it is not already available in the PATH
+              uses: julia-actions/setup-julia@v2
+              with:
+                  version: "1"
+                  arch: ${{ runner.arch }}
+              if: steps.julia_in_path.outcome != 'success'
+            - name: Use Julia cache
+              uses: julia-actions/cache@v2
+            - name: "Add the General registry via Git"
+              run: |
+                  import Pkg
+                  ENV["JULIA_PKG_SERVER"] = ""
+                  Pkg.Registry.add("General")
+              shell: julia --color=yes {0}
+            - name: "Install CompatHelper"
+              run: |
+                  import Pkg
+                  name = "CompatHelper"
+                  uuid = "aa819f21-2bde-4658-8897-bab36330d9b7"
+                  version = "3"
+                  Pkg.add(; name, uuid, version)
+              shell: julia --color=yes {0}
+            - name: "Run CompatHelper"
+              run: |
+                  import CompatHelper
+                  CompatHelper.main()
+              shell: julia --color=yes {0}
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+                  COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
+                  # COMPATHELPER_PRIV: ${{ secrets.COMPATHELPER_PRIV }}