Skip to content

Commit b99e45d

Browse files
committed
Initial commit
0 parents  commit b99e45d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+7940
-0
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[email protected]. All complaints will be reviewed and investigated promptly
64+
and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
126+
at [https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations
133+

.github/dependabot.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"

.github/workflows/ci.yaml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: ci
2+
on:
3+
push:
4+
branches: [main]
5+
tags: ['v*']
6+
pull_request:
7+
branches: [main]
8+
schedule:
9+
- cron: '15 22 * * *'
10+
workflow_dispatch: {} # support manual runs
11+
permissions:
12+
contents: read
13+
jobs:
14+
ci:
15+
runs-on: ubuntu-latest
16+
strategy:
17+
matrix:
18+
go-version: [1.22.x, 1.23.x]
19+
steps:
20+
- name: Checkout Code
21+
uses: actions/checkout@v4
22+
with:
23+
fetch-depth: 1
24+
- name: Install Go
25+
uses: actions/setup-go@v5
26+
with:
27+
go-version: ${{ matrix.go-version }}
28+
- name: Test
29+
run: make test
30+
- name: Lint
31+
# Often, lint & gofmt guidelines depend on the Go version. To prevent
32+
# conflicting guidance, run only on the most recent supported version.
33+
# For the same reason, only check generated code on the most recent
34+
# supported version.
35+
if: matrix.go-version == '1.23.x'
36+
run: make checkgenerate && make lint
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: Bypass review in case of emergency
2+
on:
3+
pull_request:
4+
types:
5+
- labeled
6+
permissions:
7+
pull-requests: write
8+
jobs:
9+
approve:
10+
if: github.event.label.name == 'Emergency Bypass Review'
11+
uses: bufbuild/base-workflows/.github/workflows/emergency-review-bypass.yaml@main
12+
secrets: inherit
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: PR Approval Bypass Notifier
2+
on:
3+
pull_request:
4+
types:
5+
- closed
6+
branches:
7+
- main
8+
permissions:
9+
pull-requests: read
10+
jobs:
11+
approval:
12+
uses: bufbuild/base-workflows/.github/workflows/notify-approval-bypass.yaml@main
13+
secrets: inherit

.github/workflows/pr-title.yaml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Lint PR Title
2+
# Prevent writing to the repository using the CI token.
3+
# Ref: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions
4+
permissions:
5+
pull-requests: read
6+
on:
7+
pull_request:
8+
# By default, a workflow only runs when a pull_request's activity type is opened,
9+
# synchronize, or reopened. We explicity override here so that PR titles are
10+
# re-linted when the PR text content is edited.
11+
types:
12+
- opened
13+
- edited
14+
- reopened
15+
- synchronize
16+
jobs:
17+
lint:
18+
uses: bufbuild/base-workflows/.github/workflows/pr-title.yaml@main

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/.tmp/
2+
*.pprof
3+
*.svg
4+
cover.out

.golangci.yml

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
linters-settings:
2+
errcheck:
3+
check-type-assertions: true
4+
forbidigo:
5+
forbid:
6+
- '^fmt\.Print'
7+
- '^log\.'
8+
- '^print$'
9+
- '^println$'
10+
- '^panic$'
11+
godox:
12+
# TODO, OPT, etc. comments are fine to commit. Use FIXME comments for
13+
# temporary hacks, and use godox to prevent committing them.
14+
keywords: [FIXME]
15+
varnamelen:
16+
ignore-decls:
17+
- T any
18+
- i int
19+
- wg sync.WaitGroup
20+
- id string
21+
linters:
22+
enable-all: true
23+
disable:
24+
- cyclop # covered by gocyclo
25+
- depguard # unnecessary for small libraries
26+
- err113 # way too noisy
27+
- exhaustruct # many exceptions
28+
- funlen # rely on code review to limit function length
29+
- gochecknoglobals # many exceptions
30+
- gocognit # dubious "cognitive overhead" quantification
31+
- gofumpt # prefer standard gofmt
32+
- goimports # rely on gci instead
33+
- gomnd # some unnamed constants are okay
34+
- inamedparam # not standard style
35+
- interfacebloat # many exceptions
36+
- ireturn # "accept interfaces, return structs" isn't ironclad
37+
- lll # don't want hard limits for line length
38+
- maintidx # covered by gocyclo
39+
- nlreturn # generous whitespace violates house style
40+
- testifylint # does not want us to use assert
41+
- testpackage # internal tests are fine
42+
- thelper # we want to print out the whole stack
43+
- wrapcheck # don't _always_ need to wrap errors
44+
- wsl # generous whitespace violates house style
45+
issues:
46+
exclude-dirs-use-default: false
47+
exclude-rules:
48+
- linters:
49+
- revive
50+
path: check/client.go
51+
test: "CheckCallOption"
52+
- linters:
53+
- revive
54+
path: check/check_service_handler.go
55+
test: "CheckServiceHandlerOption"
56+
- linters:
57+
- exhaustive
58+
path: check/options.go
59+
text: "reflect.Pointer|reflect.Ptr"
60+
- linters:
61+
- gocritic
62+
path: check/file.go
63+
text: "commentFormatting"
64+
- linters:
65+
- gocritic
66+
path: check/location.go
67+
text: "commentFormatting"
68+
- linters:
69+
- nilnil
70+
path: check/rule.go
71+
- linters:
72+
- nilnil
73+
path: check/response_writer.go
74+
- linters:
75+
- unparam
76+
path: check/category_spec.go
77+
- linters:
78+
- unparam
79+
path: check/annotation.go
80+
- linters:
81+
- unparam
82+
path: check/response.go
83+
- linters:
84+
- nilnil
85+
path: check/checktest/checktest.go
86+
- linters:
87+
- varnamelen
88+
path: check/internal/example
89+
- linters:
90+
- dupl
91+
path: check/checkutil/breaking.go
92+
- linters:
93+
- varnamelen
94+
path: check/checkutil/breaking.go
95+
- linters:
96+
- varnamelen
97+
path: check/checkutil/lint.go
98+
- linters:
99+
- varnamelen
100+
path: check/checkutil/util.go
101+
- linters:
102+
- varnamelen
103+
path: internal/pkg/xslices/xslices.go

0 commit comments

Comments
 (0)