Skip to content

Commit 2928a16

Browse files
authored
Merge pull request #7 from iruvan/community-standards
docs: add GitHub community standard files
2 parents 5c446e1 + 24c7525 commit 2928a16

6 files changed

Lines changed: 135 additions & 0 deletions

File tree

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Bug report
3+
about: Report a problem with context-debug
4+
title: ""
5+
labels: bug
6+
---
7+
8+
**Describe the bug**
9+
A clear description of what's wrong.
10+
11+
**To Reproduce**
12+
Minimal code or steps to reproduce the behavior.
13+
14+
**Expected behavior**
15+
What you expected to happen instead.
16+
17+
**Environment**
18+
- context-debug version / commit:
19+
- Go version:
20+
- OS:
21+
22+
**Additional context**
23+
Anything else relevant (logs, stack traces, etc).
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for context-debug
4+
title: ""
5+
labels: enhancement
6+
---
7+
8+
**What problem does this solve?**
9+
A clear description of the problem or use case.
10+
11+
**Proposed solution**
12+
What you'd like to see added or changed.
13+
14+
**Alternatives considered**
15+
Any alternative approaches you've thought about.
16+
17+
**Additional context**
18+
Anything else relevant.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Motivation
2+
3+
Why is this change needed?
4+
5+
## Summary
6+
7+
What changed.
8+
9+
## Test plan
10+
11+
- [ ] `go test ./...` passes
12+
- [ ] `go vet ./...` and `gofmt -l .` are clean
13+
- [ ] Manually verified (if applicable): describe how

CODE_OF_CONDUCT.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as contributors and maintainers pledge to make participation in this
6+
project a harassment-free experience for everyone, regardless of age, body
7+
size, disability, ethnicity, gender identity and expression, level of
8+
experience, nationality, personal appearance, race, religion, or sexual
9+
identity and orientation.
10+
11+
## Our Standards
12+
13+
Examples of behavior that contributes to a positive environment:
14+
15+
- Being respectful of differing viewpoints and experiences
16+
- Gracefully accepting constructive criticism
17+
- Focusing on what is best for the community
18+
19+
Examples of unacceptable behavior:
20+
21+
- Trolling, insulting or derogatory comments, and personal or political attacks
22+
- Public or private harassment
23+
- Publishing others' private information without explicit permission
24+
25+
## Enforcement
26+
27+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
28+
reported by opening a private security advisory or contacting the repository
29+
maintainer directly. All complaints will be reviewed and investigated
30+
promptly and fairly.
31+
32+
## Attribution
33+
34+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing
2+
3+
Thanks for considering a contribution to context-debug.
4+
5+
## Reporting bugs / requesting features
6+
7+
Open an issue using the appropriate template. Include a minimal reproduction
8+
where possible.
9+
10+
## Development
11+
12+
```
13+
go test ./... # run the package tests (root module)
14+
cd example && go run . # run the example HTTP service (needs POSTGRES_DSN)
15+
```
16+
17+
There is no separate lint config; rely on `go vet` and standard `gofmt`
18+
(`gofmt -l .` should report nothing before you open a PR).
19+
20+
## Submitting changes
21+
22+
1. Fork the repo and create a branch off `main`.
23+
2. Make your change, keeping it focused — unrelated cleanups belong in a
24+
separate PR.
25+
3. Ensure `go vet ./...`, `gofmt -l .`, and `go test ./...` are clean.
26+
4. Open a pull request using the PR template, describing the motivation and
27+
what changed.
28+
29+
By contributing, you agree your contributions will be licensed under this
30+
project's [license](LICENSE).

SECURITY.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
This project is pre-1.0 and tracks a single moving `main` branch. Security
6+
fixes are made against the latest commit; there are no maintained older
7+
release lines.
8+
9+
## Reporting a Vulnerability
10+
11+
Please do not open a public issue for security vulnerabilities. Instead,
12+
report them privately via [GitHub Security Advisories](../../security/advisories/new)
13+
for this repository.
14+
15+
Include as much detail as you can: affected code path, reproduction steps,
16+
and potential impact. We'll acknowledge reports as soon as possible and
17+
follow up with a fix or mitigation timeline.

0 commit comments

Comments
 (0)