Skip to content

Commit

Permalink
Initial Commit
Browse files Browse the repository at this point in the history
  • Loading branch information
FollowTheProcess committed Jul 6, 2024
0 parents commit 9d34db4
Show file tree
Hide file tree
Showing 20 changed files with 962 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Auto detect text files and perform LF normalization
* text=auto
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: 🐞 Bug Report
description: File a bug/issue
title: "<title>"
labels:
- bug

body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true

- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: false

- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false

- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
validations:
required: false

- type: textarea
attributes:
label: Environment
description: |
Please describe your execution environment providing as much detail as possible
render: Markdown
validations:
required: false

- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: 🚀 Feature Request
description: Request a new feature or enhancement
title: "<title>"
labels:
- enhancement
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the feature you want.
options:
- label: I have searched the existing issues
required: true

- type: textarea
attributes:
label: How would this feature be useful?
description: Describe any use cases this solves or frustrations it alleviates.
validations:
required: false

- type: textarea
attributes:
label: Describe the solution you'd like
description: If you have an idea on how to do this, let us know here!
validations:
required: false

- type: textarea
attributes:
label: Describe alternatives you've considered
description: If there's some workaround or alternative solutions, let us know here!
validations:
required: false

- type: textarea
attributes:
label: Anything else?
description: Any other relevant information or background.
validations:
required: false
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: ❓ Question
description: Ask something about the project
title: "<title>"
labels:
- question
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the question you want to ask.
options:
- label: I have searched the existing issues
required: true

- type: textarea
attributes:
label: Description
description: Ask your question here.
placeholder: How can I...? Is it possible to...?
validations:
required: false

- type: textarea
attributes:
label: Anything else?
description: Any other relevant information or background.
validations:
required: false
20 changes: 20 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!-- Provide a brief summary of your changes in the Title above -->

#### Description
<!-- Describe your changes in detail -->

#### Motivation and Context
<!-- Why is this change required? What problem does it solve? -->
<!-- If it fixes an open issue, please link to the issue here. -->
Closes #

#### How Has This Been Tested?
<!-- Please describe in detail how you tested your changes. -->
<!-- Include details of your testing environment, tests ran to see how -->
<!-- your change affects other areas of the code, etc. -->

#### Checklist
<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] I have updated the documentation if needed.
- [ ] I have updated the tests if needed.
13 changes: 13 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
version: 2

updates:
- package-ecosystem: github-actions
directory: /
schedule:
interval: weekly

- package-ecosystem: gomod
directory: /
rebase-strategy: auto
schedule:
interval: weekly
75 changes: 75 additions & 0 deletions .github/labels.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
- name: breaking
description: Breaking Changes
color: bfd4f2

- name: bug
description: Something isn't working
color: d73a4a

- name: build
description: Build System and Dependencies
color: bfdadc

- name: ci
description: Continuous Integration
color: 4a97d6

- name: dependencies
description: Pull requests that update a dependency file
color: 0366d6

- name: documentation
description: Improvements or additions to documentation
color: 0075ca

- name: duplicate
description: This issue or pull request already exists
color: cfd3d7

- name: enhancement
description: New feature or request
color: a2eeef

- name: good first issue
description: Good for newcomers
color: 7057ff

- name: help wanted
description: Extra attention is needed
color: 008672

- name: invalid
description: This doesn't seem right
color: e4e669

- name: performance
description: Performance
color: "016175"

- name: question
description: Further information is requested
color: d876e3

- name: refactoring
description: Refactoring
color: ef67c4

- name: removal
description: Removals and Deprecations
color: 9ae7ea

- name: style
description: Style
color: c120e5

- name: chore
description: General project admin
color: cfd3d7

- name: testing
description: Testing
color: b1fc6f

- name: wontfix
description: This will not be worked on
color: ffffff
42 changes: 42 additions & 0 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name-template: "v$RESOLVED_VERSION"
tag-template: "v$RESOLVED_VERSION"

categories:
- title: ":boom: Breaking Changes"
label: breaking

- title: ":rocket: Features"
label: enhancement

- title: ":fire: Removals and Deprecations"
label: removal

- title: ":beetle: Fixes"
label: bug

- title: ":racehorse: Performance"
label: performance

- title: ":rotating_light: Testing"
label: testing

- title: ":construction_worker: Continuous Integration"
label: ci

- title: ":books: Documentation"
label: documentation

- title: ":hammer: Refactoring"
label: refactoring

- title: ":lipstick: Style"
label: style

- title: ":package: Dependencies"
labels:
- dependencies
- build

template: |
## Changes
$CHANGES
86 changes: 86 additions & 0 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
name: CI

on:
workflow_call:
pull_request:
push:
branches:
- main

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

permissions: {}

jobs:
test:
name: Test
runs-on: ${{ matrix.os }}
permissions:
contents: read
strategy:
matrix:
os:
- ubuntu-latest
- macos-latest
- windows-latest

steps:
- name: Checkout Code
uses: actions/checkout@v4

- name: Set up Go
uses: actions/setup-go@v5
with:
go-version-file: go.mod

- name: Run Tests
run: go test -race ./...

cov:
name: CodeCov
runs-on: ubuntu-latest
permissions:
contents: read

steps:
- name: Checkout Code
uses: actions/checkout@v4

- name: Set up Go
uses: actions/setup-go@v5
with:
go-version-file: go.mod

- name: Run Tests
run: go test -race -cover -covermode=atomic -coverprofile=./coverage.out ./...

- name: Coverage
uses: codecov/codecov-action@v4
with:
files: ./coverage.out
# token: ${{ secrets.CODECOV_TOKEN }}

lint:
name: Lint
runs-on: ubuntu-latest
permissions:
contents: read

steps:
- name: Checkout Code
uses: actions/checkout@v4

- name: Set up Go
uses: actions/setup-go@v5
with:
go-version-file: go.mod

- name: Clean Mod Cache # See https://github.com/golangci/golangci-lint-action/issues/135
run: go clean -modcache

- name: Run Linting
uses: golangci/golangci-lint-action@v6
with:
version: latest
24 changes: 24 additions & 0 deletions .github/workflows/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Labeler

on:
push:
branches:
- main

permissions: read-all

jobs:
labeler:
name: Labeler
runs-on: ubuntu-latest
permissions:
contents: write
issues: write
steps:
- name: Check out the repository
uses: actions/checkout@v4

- name: Run Labeler
uses: crazy-max/ghaction-github-labeler@v5
with:
skip-delete: false
Loading

0 comments on commit 9d34db4

Please sign in to comment.