Merge pull request #1 from essentialkaos/develop

Version 0.0.1

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,42 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at `[email protected]`. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.

.github/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# Contributing Guidelines
+
+**IMPORTANT! Contribute your code only if you have an excellent understanding of project idea and all existing code base. Otherwise, a nicely formatted issue will be more helpful to us.**
+
+### Issues
+
+1. Provide product version where the problem was found;
+2. Provide info about your environment;
+3. Provide detailed info about your problem;
+4. Provide steps to reproduce the problem;
+5. Provide actual and expected results.
+
+### Code
+
+1. Check your code **before** creating pull request;
+2. If tests are present in a project, add tests for your code;
+3. Add inline documentation for your code;
+4. Apply code style used throughout the project;
+5. Create your pull request to `develop` branch (_pull requests to other branches are not allowed_).

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,54 @@
+name: ❗ Bug Report
+description: File a bug report
+title: "[Bug]: "
+labels: ["issue • bug"]
+assignees:
+  - andyone
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        > [!IMPORTANT]  
+        > Before you open an issue, search GitHub Issues for a similar bug reports. If so, please add a 👍 reaction to the existing issue.
+
+  - type: dropdown
+    id: version
+    attributes:
+      label: Install tools
+      description: How did you install this application
+      options:
+        - From Sources
+      default: 0
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Steps to reproduce
+      description: Short guide on how to reproduce this problem on our site
+      placeholder: |
+        1. [First Step]
+        2. [Second Step]
+        3. [and so on...]
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Expected behavior
+      description: What you expected to happen
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Actual behavior
+      description: What actually happened
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Additional info
+      description: Include gist of relevant config, logs, etc.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,20 @@
+name: ❓ Question
+description: Question about application, configuration or code
+title: "[Question]: "
+labels: ["issue • question"]
+assignees:
+  - andyone
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        > [!IMPORTANT]  
+        > Before you open an issue, search GitHub Issues for a similar question. If so, please add a 👍 reaction to the existing issue.
+
+  - type: textarea
+    attributes:
+      label: Question
+      description: Detailed question
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/suggestion.yml

@@ -0,0 +1,43 @@
+name: ➕ Suggestion
+description: Suggest new feature or improvement
+title: "[Suggestion]: "
+labels: ["issue • suggestion"]
+assignees:
+  - andyone
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        > [!IMPORTANT]  
+        > Before you open an issue, search GitHub Issues for a similar feature requests. If so, please add a 👍 reaction to the existing issue.
+        >
+        > Opening a feature request kicks off a discussion. Requests may be closed if we're not actively planning to work on them.
+
+  - type: textarea
+    attributes:
+      label: Proposal
+      description: Description of the feature
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Current behavior
+      description: What currently happens
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Desired behavior
+      description: What you would like to happen
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Use case
+      description: Why is this important (helps with prioritizing requests)
+    validations:
+      required: true

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,24 @@
+### What did you implement:
+
+Closes #XXXXX
+
+### How did you implement it:
+
+...
+
+### How can we verify it:
+
+...
+
+### TODO's:
+
+- [ ] Write tests
+- [ ] Write documentation
+- [ ] Check that there aren't other open pull requests for the same issue/feature
+- [ ] Format your source code by `make fmt`
+- [ ] Provide verification config / commands
+- [ ] Enable "Allow edits from maintainers" for this PR
+- [ ] Update the messages below
+
+**Is this ready for review?:** No
+**Is it a breaking change?:** No

.github/dependabot.yml

@@ -0,0 +1,36 @@
+version: 2
+
+updates:
+  - package-ecosystem: "gomod"
+    directory: "/"
+    target-branch: "develop"
+    schedule:
+      interval: "daily"
+      timezone: "Europe/London"
+      time: "03:00"
+    labels:
+      - "PR • MAINTENANCE"
+    assignees:
+      - "andyone"
+    reviewers:
+      - "andyone"
+    groups:
+      all:
+        applies-to: version-updates
+        update-types:
+          - "minor"
+          - "patch"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    target-branch: "develop"
+    schedule:
+      interval: "daily"
+      timezone: "Europe/London"
+      time: "04:00"
+    labels:
+      - "PR • MAINTENANCE"
+    assignees:
+      - "andyone"
+    reviewers:
+      - "andyone"

.github/workflows/ci.yml

@@ -0,0 +1,60 @@
+name: CI
+
+on:
+  push:
+    branches: [master, develop]
+  pull_request:
+    branches: [master]
+  workflow_dispatch:
+    inputs:
+      force_run:
+        description: 'Force workflow run'
+        required: true
+        type: choice
+        options: [yes, no]
+
+permissions:
+  actions: read
+  contents: read
+  statuses: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  Go:
+    name: Go
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        go: [ '1.21.x' ]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ matrix.go }}
+
+      - name: Download dependencies
+        run: make deps
+
+      - name: Run tests
+        run: make all
+
+  Typos:
+    name: Typos
+    runs-on: ubuntu-latest
+
+    needs: Go
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Check spelling
+        uses: crate-ci/typos@master

.github/workflows/codeql.yml

@@ -0,0 +1,33 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [master, develop]
+  pull_request:
+    branches: [master]
+  schedule:
+    - cron: '0 3 * * */2'
+
+permissions:
+  security-events: write
+  actions: read
+  contents: read
+
+jobs:
+  analyse:
+    name: Analyse
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 2
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: go
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3

.typos.toml

@@ -0,0 +1,2 @@
+[files]
+extend-exclude = ["go.sum"]