@@ -141,77 +141,6 @@ go get -u github.com/bsv-blockchain/go-subtree
141141
142142</details >
143143
144- <details >
145- <summary ><strong ><code >Repository File Glossary</code ></strong ></summary >
146- <br />
147-
148- This glossary describes each tracked file in the repository and notes if it is required for GitHub or another external service.
149-
150- | File Path | Description | Service |
151- | ------------------------------------------------------------------------------------------------| -------------------------------------------------| ------------------|
152- | [ .cursorrules] ( .cursorrules ) | Rules for Cursor AI integrations | Cursor |
153- | [ .devcontainer/devcontainer.json] ( .devcontainer/devcontainer.json ) | VS Code dev or GitHub container configuration | VS Code & GitHub |
154- | [ .dockerignore] ( .dockerignore ) | Paths ignored by Docker builds | Docker |
155- | [ .editorconfig] ( .editorconfig ) | Editor configuration defaults | Editor |
156- | [ .gitattributes] ( .gitattributes ) | Git attributes and export settings | Git |
157- | [ .github/AGENTS.md] ( .github/AGENTS.md ) | Contribution rules and guidelines | GitHub |
158- | [ .github/CLAUDE.md] ( .github/CLAUDE.md ) | Claude agent instructions | Claude |
159- | [ .github/CODEOWNERS] ( .github/CODEOWNERS ) | Code ownership declarations for GitHub | GitHub |
160- | [ .github/CODE_OF_CONDUCT.md] ( .github/CODE_OF_CONDUCT.md ) | Community behavior standards | GitHub |
161- | [ .github/CODE_STANDARDS.md] ( .github/CODE_STANDARDS.md ) | Coding style guide | GitHub |
162- | [ .github/CONTRIBUTING.md] ( .github/CONTRIBUTING.md ) | How to contribute to the project | GitHub |
163- | [ .github/FUNDING.yml] ( .github/FUNDING.yml ) | Funding links displayed by GitHub | GitHub |
164- | [ .github/ISSUE_TEMPLATE/bug_report.yml] ( .github/ISSUE_TEMPLATE/bug_report.yml ) | Issue template for bug reports | GitHub |
165- | [ .github/ISSUE_TEMPLATE/feature_request.yml] ( .github/ISSUE_TEMPLATE/feature_request.yml ) | Issue template for feature requests | GitHub |
166- | [ .github/ISSUE_TEMPLATE/question.yml] ( .github/ISSUE_TEMPLATE/question.yml ) | Issue template for questions | GitHub |
167- | [ .github/SECURITY.md] ( .github/SECURITY.md ) | Security policy | GitHub |
168- | [ .github/SUPPORT.md] ( .github/SUPPORT.md ) | Support guidelines | GitHub |
169- | [ .github/dependabot.yml] ( .github/dependabot.yml ) | Dependabot configuration | GitHub |
170- | [ .github/labels.yml] ( .github/labels.yml ) | Repository label definitions | GitHub |
171- | [ .github/pull_request_template.md] ( .github/pull_request_template.md ) | Pull request description template | GitHub |
172- | [ .github/sweep.yaml] ( .github/sweep.yaml ) | Sweep AI configuration | Sweep AI |
173- | [ .github/workflows/auto-merge-on-approval.yml] ( .github/workflows/auto-merge-on-approval.yml ) | Workflow for automatic merges | GitHub Actions |
174- | [ .github/workflows/check-for-leaks.yml] ( .github/workflows/check-for-leaks.yml ) | Secret leak detection workflow | GitHub Actions |
175- | [ .github/workflows/clean-runner-cache.yml] ( .github/workflows/clean-runner-cache.yml ) | Cleanup for GitHub runners | GitHub Actions |
176- | [ .github/workflows/codeql-analysis.yml] ( .github/workflows/codeql-analysis.yml ) | CodeQL security analysis workflow | GitHub Actions |
177- | [ .github/workflows/delete-merged-branches.yml] ( .github/workflows/delete-merged-branches.yml ) | Auto delete merged branches | GitHub Actions |
178- | [ .github/workflows/dependabot-auto-merge.yml] ( .github/workflows/dependabot-auto-merge.yml ) | Auto merge Dependabot PRs | GitHub Actions |
179- | [ .github/workflows/pull-request-management.yml] ( .github/workflows/pull-request-management.yml ) | Pull request triage workflow | GitHub Actions |
180- | [ .github/workflows/release.yml] ( .github/workflows/release.yml ) | Release workflow using GoReleaser | GitHub Actions |
181- | [ .github/workflows/run-tests.yml] ( .github/workflows/run-tests.yml ) | CI test workflow | GitHub Actions |
182- | [ .github/workflows/scorecard.yml] ( .github/workflows/scorecard.yml ) | OpenSSF Scorecard workflow | GitHub Actions |
183- | [ .github/workflows/stale.yml] ( .github/workflows/stale.yml ) | Close stale issues and PRs | GitHub Actions |
184- | [ .github/workflows/sync-labels.yml] ( .github/workflows/sync-labels.yml ) | Sync repository labels | GitHub Actions |
185- | [ .github/workflows/update-pre-commit-hooks.yml] ( .github/workflows/update-pre-commit-hooks.yml ) | Automatically update pre-commit hooks | GitHub Actions |
186- | [ .github/workflows/update-pip-requirements.yml] ( .github/workflows/update-pip-requirements.yml ) | Update Python requirements for pre-commit hooks | GitHub Actions |
187- | [ .gitignore] ( .gitignore ) | Files and directories Git should ignore | Git |
188- | [ .gitpod.yml] ( .gitpod.yml ) | Gitpod workspace configuration | Gitpod |
189- | [ .golangci.json] ( .golangci.json ) | GolangCI-Lint configuration | GolangCI-Lint |
190- | [ .goreleaser.yml] ( .goreleaser.yml ) | GoReleaser configuration for release automation | GoReleaser |
191- | [ .make/common.mk] ( .make/common.mk ) | Shared make tasks | Make |
192- | [ .make/go.mk] ( .make/go.mk ) | Go-specific make tasks | Make |
193- | [ .make/temp.mk] ( .make/temp.mk ) | Temporary makefile for internal use | Make |
194- | [ .pre-commit-config.yaml] ( .pre-commit-config.yaml ) | Pre-commit hooks configuration | Pre-commit |
195- | [ .vscode/extensions.json] ( .vscode/extensions.json ) | Recommended VS Code extensions | VS Code |
196- | [ .vscode/launch.json] ( .vscode/launch.json ) | VS Code debugging configuration | VS Code |
197- | [ .vscode/settings.json] ( .vscode/settings.json ) | VS Code workspace settings | VS Code |
198- | [ .vscode/tasks.json] ( .vscode/tasks.json ) | VS Code tasks configuration | VS Code |
199- | [ CITATION.cff] ( CITATION.cff ) | Citation metadata recognized by GitHub | GitHub |
200- | [ Dockerfile] ( Dockerfile ) | Docker image build instructions | Docker |
201- | [ LICENSE] ( LICENSE ) | Project license | Yours! |
202- | [ Makefile] ( Makefile ) | Build and lint automation | Make |
203- | [ README.md] ( README.md ) | Project overview and usage | Yours! |
204- | [ codecov.yml] ( codecov.yml ) | Codecov upload configuration | Codecov |
205- | [ examples/example.go] ( examples/example.go ) | Example usage of the library | None |
206- | [ go.mod] ( go.mod ) | Go module definition | Go |
207- | [ go.sum] ( go.sum ) | Dependency checksums generated by Go | Go |
208- | [ template.go] ( template.go ) | Main package source code | Yours! |
209- | [ template_benchmark_test.go] ( template_benchmark_test.go ) | Go benchmark tests | Go test |
210- | [ template_example_test.go] ( template_example_test.go ) | Example tests for documentation | Go test |
211- | [ template_fuzz_test.go] ( template_fuzz_test.go ) | Go fuzz tests | Go test |
212- | [ template_test.go] ( template_test.go ) | Unit tests | Go test |
213- </details >
214-
215144<details >
216145<summary ><strong ><code >Library Deployment</code ></strong ></summary >
217146<br />
@@ -230,12 +159,6 @@ To generate a snapshot (non-versioned) release for testing purposes, run:
230159make release-snap
231160```
232161
233- Before tagging a new version, update the release metadata in the ` CITATION.cff ` file:
234-
235- ``` bash
236- make citation version=0.2.1
237- ```
238-
239162Then create and push a new Git tag using:
240163
241164``` bash
@@ -405,7 +328,7 @@ Edit `AGENTS.md` first when adjusting these policies, and keep the other files i
405328
406329## 👥 Maintainers
407330| [ <img src =" https://github.com/icellan.png " height =" 50 " alt =" Siggi " />] ( https://github.com/icellan ) |
408- | :------------------------------------------------------------------------------------------------:|
331+ | :-------------------------------------------------------------------------------------------------- :|
409332| [ Siggi] ( https://github.com/icellan ) |
410333
411334<br />
0 commit comments