Merge pull request #10 from NotAShelf/ci-rework

Ci rework

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,60 @@
+name: "🐛 Bug Report"
+description: "Submit a bug report to help us improve"
+#title: "[Bug] "
+labels: [bug]
+body:
+  - type: checkboxes
+    id: no-duplicate-issues
+    attributes:
+      label: "⚠️ Please verify that this bug has NOT been reported before."
+      description: "Search in the issues sections by clicking [HERE](https://github.com/notashelf/neovim-flake4/issues?q=)"
+      options:
+        - label: "I checked all existing issues and didn't find a similar issue"
+          required: true
+  - type: textarea
+    id: description
+    validations:
+      required: false
+    attributes:
+      label: "Description"
+      description: "You could also upload screenshots, if necessary"
+  - type: textarea
+    id: steps-to-reproduce
+    validations:
+      required: true
+    attributes:
+      label: "👟 Reproduction steps"
+      description: "How do you trigger this bug? Please walk us through the problem, step by step"
+      placeholder: "..."
+  - type: textarea
+    id: expected-behavior
+    validations:
+      required: true
+    attributes:
+      label: "👀 Expected behavior"
+      description: "What did you think would or should happen?"
+      placeholder: "..."
+  - type: textarea
+    id: actual-behavior
+    validations:
+      required: true
+    attributes:
+      label: "😓 Actual Behavior"
+      description: "What actually happen?"
+      placeholder: "..."
+  - type: input
+    id: nix-metadata
+    attributes:
+      label: "💻 Metadata"
+      description: 'Please run `nix-shell -p nix-info --run "nix-info -m"` and paste the result.'
+      placeholder: '[user@system:~]$ nix-shell -p nix-info --run "nix-info -m"'
+    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: bash
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -0,0 +1,58 @@
+name: 🚀 Feature Request
+description: "Propose a new feature"
+#title: "[Feature] "
+labels: [feature-request]
+body:
+  - type: checkboxes
+    id: no-duplicate-issues
+    attributes:
+      label: "⚠️ Please verify that this feature request has NOT been suggested before."
+      description: "Search in the issues sections by clicking [HERE](https://github.com/notashelf/neovim-flake/issues?q=)"
+      options:
+        - label: "I checked and didn't find a similar feature request"
+          required: true
+  - type: dropdown
+    id: feature-area
+    attributes:
+      label: "🏷️ Feature Type"
+      description: "What kind of a feature request is this?"
+      multiple: true
+      options:
+        - New Command
+        - New Addon
+        - API Additions
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    id: feature-description
+    validations:
+      required: true
+    attributes:
+      label: "🔖 Feature description"
+      description: "A clear and concise description of what your feature request is."
+      placeholder: "'You should add [...]' or '[...] has always frustrated me' "
+  - type: textarea
+    id: solution
+    validations:
+      required: true
+    attributes:
+      label: "✔️ Solution"
+      description: "A clear and concise description of what you want to happen."
+      placeholder: "In my use-case, I would like [...]"
+  - type: textarea
+    id: alternatives
+    validations:
+      required: false
+    attributes:
+      label: "❓ Alternatives"
+      description: "A clear and concise description of any alternative solutions or features you've considered."
+      placeholder: "I have considered [...]"
+  - type: textarea
+    id: additional-context
+    validations:
+      required: false
+    attributes:
+      label: "📝 Additional Context"
+      description: "Add any other context or screenshots about the feature request here."
+      placeholder: "..."

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,40 @@
+# Description
+
+A clear and concise description of the aim of your Pull Request.
+
+**If your pull request aims to fix an open issue or a present bug, please link the relevant issue below. If not, please remove this section**
+Fixes #(issue)
+
+## Type of change
+
+Please delete any 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)
+- Translation/Language update
+- Docs
+- Other
+
+## Checklist
+
+Please try to check at least a majority of the checklist before opening your pull request. PRs 
+Exceptions to this will be reviewed on a case by case basis.
+
+- [ ] My code follows the style and contributing guidelines of this project.
+- [ ] I ran Alejandra to format my code.
+- [ ] I have performed a self-review of my own code and tested it.
+- [ ] I have commented my code, particularly in hard-to-understand areas.
+- [ ] My changes generate no new warnings.
+- [ ] This change requires a documentation update.
+- [ ] I have updated the documentation accordingly.
+
+## Screenshots & Logs
+
+You are kindly requested to attach screenshots of your changes in actions and preferably your build/run logs for all available packages. If you are not sure how to do this, you can refer to the [documentation](https://notashelf.github.io/neovim-flake/).
+
+**Please do not use any external image service. Instead, just paste in or drag and drop the image here, and it will be uploaded automatically.**
+
+```console
+# Paste your logs here
+```

.github/README.md

@@ -1,3 +1,4 @@
+<h1 align="center">neovim-flake</h1>
 <div align="center"><p>
     <a href="https://github.com/NotAShelf/neovim-flake/releases/latest">
       <img alt="Latest release" src="https://img.shields.io/github/v/release/NotAShelf/neovim-flake?style=for-the-badge&logo=nixos&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41" />

.github/workflows/cachix.yml

@@ -6,9 +6,9 @@ on:
     branches:
       - main
     paths-ignore:
-      - '.github/**'
-      - './assets/**'
-      - '.gitignore'
+      - .github/**
+      - assets/**
+      - .gitignore
 
 jobs:
   nix:
@@ -44,5 +44,5 @@ jobs:
         run: git config --global init.defaultBranch main
       - name: Validate Flakes
         run: nix flake check
-      - name: Build Hyprland with default settings
+      - name: Build Hneovim-flake with default settings
         run: nix build .#${{ matrix.package }} --print-build-logs

.github/workflows/check.yml

@@ -5,6 +5,10 @@ on:
   push:
     branches:
       - main
+    paths-ignore:
+      - .github/**
+      - assets/**
+      - .gitignore
 jobs:
   nix-flake-check:
     runs-on: ubuntu-latest

.github/workflows/manual.yml

@@ -4,6 +4,9 @@ on:
   push:
     branches:
       - main
+    paths: 
+      # build the manuals only when docs directory is updated
+      - docs/**
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions: