Skip to content

Commit

Permalink
Dev (#15)
Browse files Browse the repository at this point in the history
  • Loading branch information
lindsaygelle authored Sep 27, 2023
1 parent 005947b commit e440467
Show file tree
Hide file tree
Showing 41 changed files with 728 additions and 1,903 deletions.
20 changes: 20 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# http://editorconfig.org
root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false

[{Makefile,go.mod,go.sum,*.go,.gitmodules}]
indent_style = tab
indent_size = 4

[Dockerfile]
indent_size = 4
2 changes: 2 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
github:
- lindsaygelle
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Issue Template
Issue Template
75 changes: 75 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
name: Bug Report
description: Report a bug
title: (short issue description)
labels:
- bug
assignees:
- lindsaygelle
body:
- type: textarea
id: description
attributes:
label: Describe the bug
description: What is the problem? A clear and concise description of the bug.
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: |
What did you expect to happen?
validations:
required: true
- type: textarea
id: current
attributes:
label: Current Behavior
description: |
What actually happened?
Please include full errors, uncaught exceptions, stack traces, and relevant logs.
If service responses are relevant, please include wire logs.
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Reproduction Steps
description: |
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
For more complex issues provide a repo with the smallest sample that reproduces the bug.
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
The code sample should be an SSCCE. See http://sscce.org/ for details. In short, please provide a code sample that we can copy/paste, run and reproduce.
validations:
required: true
- type: textarea
id: solution
attributes:
label: Possible Solution
description: |
Suggest a fix/reason for the bug
validations:
required: false
- type: textarea
id: context
attributes:
label: Additional Information/Context
description: |
Anything else that might be relevant for troubleshooting this bug. Providing context helps us come up with a solution that is most useful in the real world.
validations:
required: false
- type: input
id: sdk-version
attributes:
label: SDK version used
validations:
required: true
- type: input
id: environment
attributes:
label: Environment details (OS name and version, etc.)
validations:
required: true
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
blank_issues_enabled: false
contact_links:
- name: General Question
url: https://github.com/lindsaygelle/hashtable/discussions/categories/q-a
about: Please ask and answer questions as a discussion thread
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
name: Feature Request
description: Suggest an idea for this project
title: "(short issue description)"
labels:
- feature-request
- needs-triage
assignees:
- lindsaygelle
body:
- type: textarea
id: description
attributes:
label: Describe the feature
description: A clear and concise description of the feature you are proposing.
validations:
required: true
- type: textarea
id: use-case
attributes:
label: Use Case
description: |
Why do you need this feature? For example: "I'm always frustrated when..."
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed Solution
description: |
Suggest how to implement the addition or change. Please include prototype/workaround/sketch/reference implementation.
validations:
required: false
- type: textarea
id: other
attributes:
label: Other Information
description: |
Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc.
validations:
required: false
- type: checkboxes
id: ack
attributes:
label: Acknowledgements
options:
- label: I may be able to implement this feature request
required: false
- label: This feature might incur a breaking change
required: false
- type: input
id: sdk-version
attributes:
label: SDK version used
validations:
required: true
- type: input
id: environment
attributes:
label: Environment details (OS name and version, etc.)
validations:
required: true
25 changes: 25 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
### Description
[Provide a brief description of the changes in this pull request.]

### Related Issue
[Reference any related issue(s) or feature request(s) here. For example: "Closes #123"]

### Changes Made
[Explain the changes you made in this pull request. Include any relevant details about code modifications, added features, or bug fixes.]

### Screenshots (if applicable)
[If your changes include visual updates or additions, provide screenshots to showcase them.]

### How to Test
[Explain how reviewers or others can test your changes. Include specific steps, commands, or scenarios to verify the functionality.]

### Checklist
- [ ] I have followed the coding style guidelines of the project.
- [ ] My code passes all existing unit tests.
- [ ] I have added new unit tests to cover the changes where applicable.
- [ ] I have updated the documentation to reflect the changes.
- [ ] My changes do not introduce any new warnings or errors.
- [ ] I have tested my changes thoroughly.

### Additional Notes
[Include any additional information, context, or notes that might be helpful for reviewers.]
16 changes: 16 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
version: 2
updates:
# Go dependency updates
- package-ecosystem: gomod
directory: /
schedule:
interval: daily
labels:
- dependencies
# GitHub actions updates
- package-ecosystem: github-actions
directory: /
schedule:
interval: daily
labels:
- dependencies
37 changes: 37 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: codeql

on:
push:
branches:
- main
pull_request:
branches:
- main
schedule:
- cron: 30 1 * * *

jobs:
main:
defaults:
run:
shell: bash
permissions:
actions: read
contents: read
security-events: write
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
strategy:
fail-fast: false
matrix:
language:
- go
timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
steps:
- uses: actions/checkout@v4
- uses: github/codeql-action/init@v2
with:
languages: ${{ matrix.language }}
- uses: github/codeql-action/autobuild@v2
- uses: github/codeql-action/analyze@v2
with:
category: "/language:${{ matrix.language }}"
28 changes: 0 additions & 28 deletions .github/workflows/go.yml

This file was deleted.

42 changes: 42 additions & 0 deletions .github/workflows/pull_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: pull_request

on:
pull_request:
workflow_dispatch:

jobs:

lint:
defaults:
run:
shell: bash
permissions:
contents: read
runs-on: ubuntu-latest
strategy:
fail-fast: false
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
- uses: pre-commit/[email protected]

test:
defaults:
run:
shell: bash
permissions:
contents: read
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os:
- macos-latest
- ubuntu-latest
- windows-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-go@v4
- run: go install golang.org/x/lint/golint@latest
- run: golint -set_exit_status ./...
- run: go test ./... -v
31 changes: 31 additions & 0 deletions .github/workflows/stale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: stale

on:
schedule:
- cron: 30 1 * * *

jobs:
main:
defaults:
run:
shell: bash
permissions:
contents: read
runs-on: ubuntu-latest
strategy:
fail-fast: false
steps:
- uses: actions/stale@v8
with:
days-before-issue-close: 5
days-before-issue-stale: 30
days-before-pr-close: 10
days-before-pr-stale: 45
close-issue-message: |
This issue was closed because it has been stalled for 5 days with no activity.
close-pr-message: |
This PR was closed because it has been stalled for 10 days with no activity.
stale-issue-message: |
This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.
stale-pr-message: |
This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.
13 changes: 12 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,12 +1,23 @@
# If you prefer the allow list template instead of the deny list, see community template:
# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
#
# Binaries for programs and plugins
*.exe
*.exe~
*.dll
*.so
*.dylib

# Test binary, build with `go test -c`
# Test binary, built with `go test -c`
*.test

# Output of the go coverage tool, specifically when used with LiteIDE
*.out

# Dependency directories (remove the comment below to include it)
# vendor/

# Go workspace file
go.work

venv/
Loading

0 comments on commit e440467

Please sign in to comment.