feat: add release ci job, add semantic verioning

.claude/settings.json

@@ -0,0 +1,7 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(curl -s -w \"\\\\n---HTTP_STATUS:%{http_code}---\" https://raw.githubusercontent.com/kubernetes/kubernetes/master/.markdownlint.yaml)"
+    ]
+  }
+}

.gitea/ISSUE_TEMPLATE.yml

@@ -0,0 +1,71 @@
+name: Bug Report
+about: File a bug report
+title: "[Bug]: "
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  # some markdown that will only be visible once the issue has been created
+  - type: markdown
+    attributes:
+      value: |
+        This issue was created by an issue **template** :)
+    visible: [content]
+  - type: input
+    id: contact
+    attributes:
+      label: Contact Details
+      description: How can we get in touch with you if we need more info?
+      placeholder: ex. email@example.com
+    validations:
+      required: false
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Also tell us, what did you expect to happen?
+      placeholder: Tell us what you see!
+      value: "A bug happened!"
+    validations:
+      required: true
+  - type: dropdown
+    id: version
+    attributes:
+      label: Version
+      description: What version of our software are you running?
+      options:
+        - 1.0.2 (Default)
+        - 1.0.3 (Edge)
+    validations:
+      required: true
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: What browsers are you seeing the problem on?
+      multiple: true
+      options:
+        - Firefox
+        - Chrome
+        - Safari
+        - Microsoft Edge
+  - 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: shell
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      hide_label: true
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true
+        - label: I have also read the CONTRIBUTION.MD
+          required: true
+          visible: [form]
+        - label: This is a TODO only visible after issue creation
+          visible: [content]

.gitea/ISSUE_TEMPLATE/BUG_REPORT.yml

@@ -1,26 +0,0 @@
-# yaml-language-server: $schema=https://www.schemastore.org/gitea-issue-forms.json
-name: 🐛 Bug Report
-about: Report a bug in this project
-title: "[BUG]: "
-body:
-  - type: textarea
-    id: context
-    attributes:
-      label: Context
-      placeholder: What circumstances led to the bug?
-    validations:
-      required: true
-  - type: textarea
-    id: expected-behavior
-    attributes:
-      label: Expected Behavior
-      placeholder: What did you expect would happen?
-    validations:
-      required: true
-  - type: textarea
-    id: actual-behavior
-    attributes:
-      label: Actual Behavior
-      placeholder: What happened, and why was it unexpected?
-    validations:
-      required: true

.gitea/ISSUE_TEMPLATE/FEATURE_REQUEST.yml

@@ -1,37 +0,0 @@
-# 'Feature Request Template' By @cheehwatang
-# https://github.com/cheehwatang/.github/blob/master/.github/ISSUE_TEMPLATE/feature_request.yml
-#
-# yaml-language-server: $schema=https://www.schemastore.org/gitea-issue-forms.json
-name: ✨ Feature Request
-about: Suggest an idea for this project
-title: "[FEATURE]: "
-body:
-  - type: dropdown
-    attributes:
-      multiple: false
-      label: Feature Type
-      options:
-        - "✨ New Feature"
-        - "📝 Documentation"
-        - "🎨 Style and UI"
-        - "🔨 Code Refactor"
-        - "⚡ Performance Improvements"
-        - "✅ New Test"
-    validations:
-      required: true
-  - type: textarea
-    id: description
-    attributes:
-      label: Description
-      placeholder: |
-        Give us a brief description of the feature or enhancement you would
-        like!
-    validations:
-      required: true
-  - type: textarea
-    id: additional-information
-    attributes:
-      label: Additional Information
-      placeholder: |
-        Give us some additional information on the feature request like proposed
-        solutions, links, screenshots, etc.

.gitea/ISSUE_TEMPLATE/config.yml

@@ -1,2 +0,0 @@
-# yaml-language-server: $schema=https://www.schemastore.org/gitea-issue-config.json
-blank_issues_enabled: false

.gitea/PULL_REQUEST_TEMPLATE.md

@@ -1,17 +1,12 @@
 ---
-name: "New Pull Request"
+name: "Pull Request Template"
-about: "Standard PR template"
+about: "This template is for general pull requests!"
-title: ""
+title: "<type>[optional scope]: <description>"
 ref: "main"
+assignees: ["user1"]
+labels:
+- bug
+- "help needed"
 ---
 
-## Description
+This is the template!
-
-## Changes
-
-### Design Decisions
-
-## Checklist
-
-- [ ] Tests pass
-- [ ] Docs updated

.gitea/workflows/ci.yml

@@ -6,19 +6,6 @@ on:
   pull_request:
 
 jobs:
-  check-pr-title:
-    name: Check PR Title
-    runs-on: ubuntu-latest
-    if: github.event_name == 'pull_request'
-    env:
-      TITLE: ${{ gitea.event.pull_request.title }}
-    steps:
-      - run: |
-          if ! echo "$TITLE" | grep -qE '^(WIP: )?(feat|fix|docs|chore|ci|test|refactor|perf|build|style|revert)(\(.+\))?(!)?: .+'; then
-            echo "::error::Pull Request title must follow conventional commits"
-            exit 1
-          fi
-
   lint-go:
     name: Go Lint
     runs-on: ubuntu-latest

.gitea/workflows/release.yml

@@ -0,0 +1,22 @@
+name: Release
+on:
+  push:
+    branches: [main]
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - run: pip install python-semantic-release
+
+      - run: semantic-release version --push --vcs-release
+        env:
+          GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}

.gitignore

@@ -24,3 +24,4 @@ go.work.sum
 
 # env file
 .env
+

cuckoo_fuzz_test.go

@@ -1,9 +1,7 @@
 package cuckoo_test
 
 import (
-	"fmt"
 	"maps"
-	"os"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -28,7 +26,6 @@ type fuzzStep struct {
 
 type fuzzScenario struct {
 	seedA, seedB uint32
-	capacity, growthFactor uint8
 	steps        []fuzzStep
 }
 
@@ -43,25 +40,14 @@ func FuzzInsertLookup(f *testing.F) {
 			return
 		}
 
-		seedA, seedB := scenario.seedA, scenario.seedB
+		if scenario.seedA == scenario.seedB {
-		growthFactor := max(2, int(scenario.growthFactor))
+			return
-		capacity := int(scenario.capacity)
-
-		// If they are the same number, the hashes will clash, always causing an
-		// error.
-		if seedA == seedB {
-			t.Skip()
 		}
 
-		fmt.Fprintf(os.Stderr, "seedA=%d seedB=%d capacity=%d growthFactor=%d\n",
-			seedA, seedB, capacity, growthFactor)
-
 		actual := cuckoo.NewCustomTable[uint32, uint32](
-			offsetHash(seedA),
+			offsetHash(scenario.seedA),
-			offsetHash(seedB),
+			offsetHash(scenario.seedB),
 			func(a, b uint32) bool { return a == b },
-			cuckoo.Capacity(capacity),
-			cuckoo.GrowthFactor(growthFactor),
 		)
 
 		expected := map[uint32]uint32{}

pyproject.toml

@@ -0,0 +1,13 @@
+#:schema https://json.schemastore.org/pyproject.json
+
+[tool.semantic_release]
+commit_parser = "angular"
+version_toml = []
+tag_format = "v{version}"
+
+[tool.semantic_release.remote]
+type = "gitea"
+domain = "git.maximhutz.com"
+
+[tool.semantic_release.remote.token]
+env = "GITEA_TOKEN"

settings.go

@@ -1,7 +1,5 @@
 package cuckoo
 
-import "fmt"
-
 // DefaultCapacity is the initial capacity of a [Table]. It is inspired from
 // Java's [HashMap] implementation, which also uses 16.
 //
@@ -12,12 +10,11 @@ const DefaultCapacity uint64 = 16
 // hash table implementations use 2.
 const DefaultGrowthFactor uint64 = 2
 
-// defaultMinimumLoad is the default lowest acceptable occupancy of a [Table].
+// DefaultMinimumLoad is the default lowest acceptable occupancy of a [Table].
-// The higher the minimum load, the more likely that a [Table.Put] will not
+// The value of 5% is taken from [libcuckoo].
-// succeed. The value of 5% is taken from [libcuckoo].
 //
 // [libcuckoo]: https://github.com/efficient/libcuckoo/blob/656714705a055df2b7a605eb3c71586d9da1e119/libcuckoo/cuckoohash_config.hh#L21
-const defaultMinimumLoad float64 = 0.05
+const DefaultMinimumLoad float64 = 0.05
 
 type settings struct {
 	growthFactor  uint64
@@ -30,21 +27,19 @@ type settings struct {
 type Option func(*settings)
 
 // Capacity modifies the starting capacity of each bucket of the [Table]. The
-// value must be non-negative.
+// value must be greater than 0.
 func Capacity(value int) Option {
-	if value < 0 {
-		panic(fmt.Sprintf("go-cuckoo: Capacity must be non-negative, got %d", value))
-	}
-
 	return func(s *settings) { s.bucketSize = uint64(value) }
 }
 
+// MinimumLoad modifies the [DefaultMinimumLoad] of the [Table]. The value must
+// be between 0.00 and 1.00.
+func MinimumLoad(value float64) Option {
+	return func(s *settings) { s.minLoadFactor = value }
+}
+
 // GrowthFactor controls how much the capacity of the [Table] multiplies when
 // it must resize. The value must be greater than 1.
 func GrowthFactor(value int) Option {
-	if value < 2 {
-		panic(fmt.Sprintf("go-cuckoo: GrowthFactor must be greater than 1, got %d", value))
-	}
-
 	return func(s *settings) { s.growthFactor = uint64(value) }
 }

table.go

@@ -198,7 +198,7 @@ func NewCustomTable[K, V any](hashA, hashB Hash[K], compare EqualFunc[K], option
 	settings := &settings{
 		growthFactor:  DefaultGrowthFactor,
 		bucketSize:    DefaultCapacity,
-		minLoadFactor: defaultMinimumLoad,
+		minLoadFactor: DefaultMinimumLoad,
 	}
 
 	for _, option := range options {