Skip to content

Commit 882aef1

Browse files
ShivanshVijShivanshVij
authored
Merge pull request #1 from loopholelabs/standardizing-for-release
Standardizing the repo for release
2 parents 593b05b + d0ba88f commit 882aef1

26 files changed

+403
-144
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ""
5+
labels: bug
6+
assignees: ShivanshVij
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of what the bug is.
11+
12+
**To Reproduce**
13+
Steps to reproduce the behavior:
14+
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Additional context**
24+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Loophole Labs Community Support
4+
url: https://loopholelabs.io/discord
5+
about: Please ask and answer questions here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ""
5+
labels: enhancement
6+
assignees: ShivanshVij
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Additional context**
19+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/other.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: Other
3+
about: A different type of issue
4+
title: ""
5+
labels: question
6+
assignees: ShivanshVij
7+
---
8+
9+
**Description of the Issue. Please be as clear as possible.**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
**Additional context**
13+
Add any other context or screenshots about the issue here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## Description
2+
3+
Please include a summary of the change and which issue has been fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
4+
5+
Fixes # (issue)
6+
7+
## Type of change
8+
9+
**Please update the title of this PR to reflect the type of change.** (Delete the ones that aren't required).
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue) [title: 'fix:']
12+
- [ ] New feature (non-breaking change which adds functionality) [title: 'feat:']
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] This change requires a documentation update
15+
16+
## Testing
17+
18+
Please make sure that existing test cases pass (with `go test ./... -race` and `go test -bench=. ./... -race`),
19+
and if required please add new test cases and list them below:
20+
21+
- [ ] Test A
22+
- [ ] Test B
23+
24+
## Linting
25+
26+
Please make sure you've run the following and fixed any issues that arise:
27+
28+
- [ ] `trunk check` has been run
29+
30+
## Final Checklist:
31+
32+
- [ ] My code follows the style guidelines of this project
33+
- [ ] I have performed a self-review of my own code
34+
- [ ] I have commented my code, particularly in hard-to-understand areas
35+
- [ ] I have made corresponding changes to the documentation
36+
- [ ] My changes generate no new warnings
37+
- [ ] I have added tests that prove my fix is effective or that my feature works
38+
- [ ] New and existing unit tests pass locally with my changes
39+
- [ ] Any dependent changes have been merged and published in downstream modules
40+
- [ ] I have checked my code and corrected any misspellings

‎.github/workflows/lint.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Lint
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- "*"
7+
8+
jobs:
9+
lint:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout
13+
uses: actions/checkout@v2
14+
15+
- name: Cache Linters/Formatters
16+
uses: actions/cache@v2
17+
with:
18+
path: ~/.cache/trunk
19+
key: trunk-${{ runner.os }}
20+
21+
- name: Trunk Check
22+
uses: trunk-io/trunk-action@v1

‎.github/workflows/tests.yaml‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
name: Tests
2+
3+
on:
4+
push:
5+
branches:
6+
- "*"
7+
8+
jobs:
9+
tests:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- id: go-cache-paths
13+
run: |
14+
echo "::set-output name=go-build::$(go env GOCACHE)"
15+
echo "::set-output name=go-mod::$(go env GOMODCACHE)"
16+
17+
- name: Checkout
18+
uses: actions/checkout@v2
19+
20+
- name: Set up Go
21+
uses: actions/setup-go@v2
22+
with:
23+
go-version: 1.18
24+
25+
- name: Go Build Cache
26+
uses: actions/cache@v2
27+
with:
28+
path: ${{ steps.go-cache-paths.outputs.go-build }}
29+
key: ${{ runner.os }}-go-build-${{ hashFiles('**/go.sum') }}
30+
31+
- name: Go Mod Cache
32+
uses: actions/cache@v2
33+
with:
34+
path: ${{ steps.go-cache-paths.outputs.go-mod }}
35+
key: ${{ runner.os }}-go-mod-${{ hashFiles('**/go.sum') }}
36+
37+
- name: Test
38+
run: go test -v ./...
39+
tests-race:
40+
runs-on: ubuntu-latest
41+
steps:
42+
- id: go-cache-paths
43+
run: |
44+
echo "::set-output name=go-build::$(go env GOCACHE)"
45+
echo "::set-output name=go-mod::$(go env GOMODCACHE)"
46+
47+
- name: Checkout
48+
uses: actions/checkout@v2
49+
50+
- name: Set up Go
51+
uses: actions/setup-go@v2
52+
with:
53+
go-version: 1.18
54+
55+
- name: Go Build Cache
56+
uses: actions/cache@v2
57+
with:
58+
path: ${{ steps.go-cache-paths.outputs.go-build }}
59+
key: ${{ runner.os }}-go-build-${{ hashFiles('**/go.sum') }}
60+
61+
- name: Go Mod Cache
62+
uses: actions/cache@v2
63+
with:
64+
path: ${{ steps.go-cache-paths.outputs.go-mod }}
65+
key: ${{ runner.os }}-go-mod-${{ hashFiles('**/go.sum') }}
66+
67+
- name: Test with Race Conditions
68+
run: go test -race -v ./...
69+
timeout-minutes: 15

‎.markdownlint.yaml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Autoformatter friendly markdownlint config (all formatting rules disabled)
2+
default: true
3+
blank_lines: false
4+
bullet: false
5+
html: false
6+
indentation: false
7+
line_length: false
8+
spaces: false
9+
url: false
10+
whitespace: false
11+
first-line-h1: false
12+
no-trailing-punctuation: false
13+
no-duplicate-header: false

‎.trunk/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*out

‎.trunk/trunk.yaml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
version: 0.1
2+
cli:
3+
version: 0.13.2-beta
4+
lint:
5+
enabled:
6+
- gitleaks@8.7.1
7+
- gofmt@1.18.1
8+
- golangci-lint@1.45.2
9+
- markdownlint@0.31.1
10+
- prettier@2.6.2

0 commit comments

Comments
 (0)