Skip to content

docs: pro README + issue/PR templates + CONTRIBUTING - #69

Merged
thegdsks merged 1 commit into
mainfrom
docs/readme-overhaul-2026-06-22
Jun 23, 2026
Merged

docs: pro README + issue/PR templates + CONTRIBUTING#69
thegdsks merged 1 commit into
mainfrom
docs/readme-overhaul-2026-06-22

Conversation

@thegdsks

Copy link
Copy Markdown
Member

Summary

  • Full README rewrite: visually professional, conversion-optimized, AI-crawler-friendly
  • Replaces flat .md issue templates with YAML form-based GitHub templates
  • Updates PR template with richer checklists
  • CONTRIBUTING refresh: branch naming, em-dash rule, Code of Conduct
  • SECURITY: supported-versions table, response SLA table, GitHub Security Advisories link

New README structure

Hero block (ASCII logo + tagline + badge row + quick-start code block)
Why theauth-go (comparison table vs Auth0, better-auth, Goth, Hydra)
Features at a glance (collapsible <details>)
Quick start (3 numbered steps with real Go code)
MCP resource server (zero-dep mcpresource quickstart)
Documentation (deep links to glincker.github.io/theauth-go/)
Examples (table linking to examples/)
Storage backends (memory, postgres, mysql, storagetest)
Security (pointer to SECURITY.md + GitHub Security Advisories)
Contributing (pointer to CONTRIBUTING.md)
License
Footer: theSVG.org + GLINR STUDIOS / GLINCKER COMPANY attribution

ASCII logo

  _   _                       _   _                         
 | |_| |__   ___  __ _ _   _| |_| |__         __ _  ___   
 | __| '_ \ / _ \/ _` | | | | __| '_ \       / _` |/ _ \  
 | |_| | | |  __/ (_| | |_| | |_| | | |  _  | (_| | (_) | 
  \__|_| |_|\___|\__,_|\__,_|\__|_| |_| (_)  \__, |\___/  
                                               |___/        

New issue + PR templates

File Purpose
.github/ISSUE_TEMPLATE/bug_report.yml YAML form: version, Go version, storage, repro steps, expected vs actual, repro link, stack trace, audit evidence
.github/ISSUE_TEMPLATE/feature_request.yml YAML form: problem, proposed API (Go-highlighted), alternatives, RFC link
.github/ISSUE_TEMPLATE/security_advisory.yml Redirect: blocks public disclosure, links to email + GitHub Security Advisories
.github/PULL_REQUEST_TEMPLATE.md Type checkboxes, public API / storage / mcpresource / em-dash checklists

Founder attribution (footer)

Built by the founder of theSVG.org.

A Product of GLINR STUDIOS | A GLINCKER COMPANY

CI gates passed locally

  • gofmt: OK
  • go vet: OK
  • em-dash scan: OK
  • en-dash scan: OK

- Full README rewrite: ASCII logo, badge row, comparison table,
  collapsible feature checklist, 3-step quick start, docs deep links,
  example apps table, storage backends table, footer attribution
- Replace flat .md issue templates with YAML form-based templates:
  bug_report.yml, feature_request.yml, security_advisory.yml
- PR template: type checkboxes, public API/storage/mcpresource/em-dash
  checklists
- CONTRIBUTING: branch naming, em-dash rule, Code of Conduct link
- SECURITY: supported-versions table updated (v2.x current + prev minor),
  response SLA table, GitHub Security Advisories link
@github-actions

Copy link
Copy Markdown
Contributor

Benchmark regression report

Threshold: 25%

goos: linux
goarch: amd64
pkg: github.com/glincker/theauth-go
cpu: AMD EPYC 9V74 80-Core Processor                
                     │ base-bench.txt │         pr-bench.txt          │
                     │     sec/op     │   sec/op     vs base          │
RateLimitReadHeavy-4      75.36n ± 3%   75.83n ± 9%  ~ (p=0.171 n=10)

                     │ base-bench.txt │          pr-bench.txt          │
                     │      B/op      │    B/op     vs base            │
RateLimitReadHeavy-4       0.000 ± 0%   0.000 ± 0%  ~ (p=1.000 n=10) ¹
¹ all samples are equal

                     │ base-bench.txt │          pr-bench.txt          │
                     │   allocs/op    │ allocs/op   vs base            │
RateLimitReadHeavy-4       0.000 ± 0%   0.000 ± 0%  ~ (p=1.000 n=10) ¹
¹ all samples are equal

pkg: github.com/glincker/theauth-go/crypto
               │ base-bench.txt │            pr-bench.txt            │
               │     sec/op     │   sec/op     vs base               │
Argon2Hash-4        54.13m ± 2%   54.29m ± 2%       ~ (p=0.481 n=10)
Argon2Verify-4      54.56m ± 2%   55.14m ± 2%       ~ (p=0.143 n=10)
geomean             54.34m        54.72m       +0.68%

               │ base-bench.txt │            pr-bench.txt             │
               │      B/op      │     B/op      vs base               │
Argon2Hash-4       64.01Mi ± 0%   64.01Mi ± 0%       ~ (p=0.739 n=10)
Argon2Verify-4     64.01Mi ± 0%   64.01Mi ± 0%       ~ (p=0.726 n=10)
geomean            64.01Mi        64.01Mi       -0.00%

               │ base-bench.txt │           pr-bench.txt            │
               │   allocs/op    │ allocs/op   vs base               │
Argon2Hash-4         102.0 ± 1%   102.0 ± 0%       ~ (p=1.000 n=10)
Argon2Verify-4       103.0 ± 1%   103.0 ± 1%       ~ (p=1.000 n=10)
geomean              102.5        102.5       +0.00%

pkg: github.com/glincker/theauth-go/internal/bench
                               │ base-bench.txt │            pr-bench.txt             │
                               │     sec/op     │    sec/op     vs base               │
AuditRedactor-4                     1.400µ ± 1%    1.378µ ± 1%  -1.61% (p=0.001 n=10)
OAuthCallback-4                     988.4n ± 1%   1001.4n ± 1%  +1.32% (p=0.001 n=10)
OAuthCodeFlow-4                     50.97µ ± 1%    51.50µ ± 1%  +1.05% (p=0.000 n=10)
OAuthTokenEndpointRefreshHit-4      51.68µ ± 1%    52.25µ ± 0%  +1.10% (p=0.000 n=10)
JWKSEndpoint-4                      6.642µ ± 2%    6.677µ ± 1%       ~ (p=0.159 n=10)
SCIMTokenAuth-4                     17.20µ ± 2%    18.19µ ± 2%  +5.75% (p=0.000 n=10)
SessionLookup-4                     9.031µ ± 2%    9.631µ ± 2%  +6.64% (p=0.000 n=10)
geomean                             8.696µ         8.876µ       +2.08%

                               │ base-bench.txt │             pr-bench.txt              │
                               │      B/op      │     B/op      vs base                 │
AuditRedactor-4                      672.0 ± 0%     672.0 ± 0%       ~ (p=1.000 n=10) ¹
OAuthCallback-4                    1.344Ki ± 0%   1.344Ki ± 0%       ~ (p=1.000 n=10) ¹
OAuthCodeFlow-4                    15.79Ki ± 0%   15.79Ki ± 0%       ~ (p=0.104 n=10)
OAuthTokenEndpointRefreshHit-4     15.55Ki ± 0%   15.55Ki ± 0%       ~ (p=1.000 n=10)
JWKSEndpoint-4                     2.963Ki ± 0%   2.963Ki ± 0%       ~ (p=1.000 n=10)
SCIMTokenAuth-4                    9.765Ki ± 0%   9.765Ki ± 0%       ~ (p=0.180 n=10)
SessionLookup-4                    8.451Ki ± 0%   8.451Ki ± 0%       ~ (p=1.000 n=10) ¹
geomean                            4.730Ki        4.730Ki       +0.00%
¹ all samples are equal

                               │ base-bench.txt │            pr-bench.txt             │
                               │   allocs/op    │ allocs/op   vs base                 │
AuditRedactor-4                      4.000 ± 0%   4.000 ± 0%       ~ (p=1.000 n=10) ¹
OAuthCallback-4                      5.000 ± 0%   5.000 ± 0%       ~ (p=1.000 n=10) ¹
OAuthCodeFlow-4                      100.0 ± 0%   100.0 ± 0%       ~ (p=1.000 n=10) ¹
OAuthTokenEndpointRefreshHit-4       100.0 ± 0%   100.0 ± 0%       ~ (p=1.000 n=10) ¹
JWKSEndpoint-4                       37.00 ± 0%   37.00 ± 0%       ~ (p=1.000 n=10) ¹
SCIMTokenAuth-4                      56.00 ± 0%   56.00 ± 0%       ~ (p=1.000 n=10) ¹
SessionLookup-4                      42.00 ± 0%   42.00 ± 0%       ~ (p=1.000 n=10) ¹
geomean                              29.04        29.04       +0.00%
¹ all samples are equal

pkg: github.com/glincker/theauth-go/internal/jwt
            │ base-bench.txt │            pr-bench.txt            │
            │     sec/op     │   sec/op     vs base               │
JWTSign-4        33.30µ ± 0%   33.36µ ± 0%  +0.18% (p=0.030 n=10)
JWTVerify-4      77.78µ ± 1%   77.82µ ± 1%       ~ (p=0.912 n=10)
geomean          50.89µ        50.95µ       +0.11%

            │ base-bench.txt │             pr-bench.txt              │
            │      B/op      │     B/op      vs base                 │
JWTSign-4       2.782Ki ± 0%   2.782Ki ± 0%       ~ (p=1.000 n=10) ¹
JWTVerify-4     3.422Ki ± 0%   3.422Ki ± 0%       ~ (p=1.000 n=10) ¹
geomean         3.086Ki        3.086Ki       +0.00%
¹ all samples are equal

            │ base-bench.txt │            pr-bench.txt             │
            │   allocs/op    │ allocs/op   vs base                 │
JWTSign-4         15.00 ± 0%   15.00 ± 0%       ~ (p=1.000 n=10) ¹
JWTVerify-4       61.00 ± 0%   61.00 ± 0%       ~ (p=1.000 n=10) ¹
geomean           30.25        30.25       +0.00%
¹ all samples are equal

Generated by the bench workflow. A + delta means the PR branch is slower.

@thegdsks
thegdsks merged commit 8244e69 into main Jun 23, 2026
4 checks passed
@thegdsks
thegdsks deleted the docs/readme-overhaul-2026-06-22 branch June 23, 2026 00:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant