Skip to content

Commit bd3cd69

Browse files
author
Jake Soenneker
committed
Community files
1 parent c57e9b8 commit bd3cd69

File tree

7 files changed

+174
-1
lines changed

7 files changed

+174
-1
lines changed

‎.github/CODE_OF_CONDUCT.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Code of Conduct
2+
3+
We are committed to creating a respectful, inclusive, and harassment-free environment for everyone.
4+
5+
## Expected Behavior
6+
7+
* Be kind, considerate, and professional.
8+
* Welcome diverse perspectives and experiences.
9+
* Offer and accept constructive feedback with grace.
10+
11+
## Unacceptable Behavior
12+
13+
* Harassment, abuse, or discrimination of any kind
14+
* Personal attacks, insults, or inflammatory remarks
15+
* Sharing private information without explicit consent
16+
17+
## Reporting and Enforcement
18+
19+
If you experience or witness unacceptable behavior, please report it by emailing [[email protected]](mailto:[email protected]).
20+
All reports will be reviewed promptly, kept confidential, and handled with care.
21+
22+
This project adheres to the [Contributor Covenant](https://www.contributor-covenant.org), the most widely adopted standard for open source communities.

‎CONTRIBUTING.md renamed to ‎.github/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to Soenneker.Utils.AutoBogus
1+
# Contributing to Soenneker.Utils.AutoBogus
22

33
We're excited that you're interested in contributing!
44

‎.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: 🐛 Bug Report
2+
description: Report a problem
3+
title: "[Bug]: "
4+
labels: [bug]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: What’s the issue?
10+
description: Describe the unexpected behavior and what should happen instead
11+
placeholder: "I'm using X method, but it throws Y..."
12+
required: true
13+
14+
- type: textarea
15+
id: repro
16+
attributes:
17+
label: Reproduction steps
18+
description: Code snippets or steps to reproduce the issue
19+
placeholder: |
20+
1. Use this input...
21+
2. Call this method...
22+
3. Get this result...
23+
required: true
24+
25+
- type: textarea
26+
id: env
27+
attributes:
28+
label: Environment
29+
description: .NET version, library version, OS, runtime
30+
placeholder: ".NET 8, Windows 11, library v1.2.3"
31+
32+
- type: textarea
33+
id: logs
34+
attributes:
35+
label: Stack trace or error
36+
description: Paste any logs or exceptions
37+
render: shell

‎.github/ISSUE_TEMPLATE/documentation.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: 📝 Documentation Update
2+
description: Suggest improvements to README, XML docs, or usage examples
3+
title: "[Docs]: "
4+
labels: [documentation]
5+
body:
6+
- type: textarea
7+
id: section
8+
attributes:
9+
label: Where’s the issue?
10+
description: What part of the documentation is unclear or missing?
11+
placeholder: "The usage section for X is missing how to configure Y..."
12+
13+
- type: textarea
14+
id: suggestion
15+
attributes:
16+
label: Suggestion
17+
description: What would clarify it?
18+
19+
- type: textarea
20+
id: notes
21+
attributes:
22+
label: Context
23+
description: Anything else that would help improve it?

‎.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: ✨ Feature Request
2+
description: Suggest an improvement
3+
title: "[Feature]: "
4+
labels: [enhancement]
5+
body:
6+
- type: textarea
7+
id: proposal
8+
attributes:
9+
label: What should be added?
10+
description: Describe the new feature, method, or behavior
11+
placeholder: "It would help to have a method that..."
12+
13+
- type: textarea
14+
id: usecase
15+
attributes:
16+
label: What’s the use case?
17+
description: What developer problem does this solve?
18+
placeholder: "This would help when building..."
19+
20+
- type: textarea
21+
id: api
22+
attributes:
23+
label: Suggested API (optional)
24+
description: If applicable, propose a sample method, interface, or signature
25+
placeholder: "Maybe something like: `DoThingAsync(MyOptions options)`"

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!-- Pull Request Template -->
2+
3+
## Description
4+
5+
Please include a summary of the changes and the related issue.
6+
Clearly describe the problem and how this PR addresses it.
7+
8+
Fixes: #<issue-number> (if applicable)
9+
10+
---
11+
12+
## Type of Change
13+
14+
Please delete options that are not relevant.
15+
16+
- [ ] 🐛 Bug fix
17+
- [ ] ✨ New feature
18+
- [ ] 🔧 Refactor
19+
- [ ] 📝 Documentation update
20+
- [ ] ✅ Test improvement
21+
- [ ] 🔁 Chore / Maintenance
22+
23+
---
24+
25+
## Checklist
26+
27+
- [ ] I’ve added/updated necessary tests
28+
- [ ] I’ve added/updated documentation
29+
- [ ] My code follows the code style of this project
30+
- [ ] I’ve tested this manually
31+
32+
---
33+
34+
## Screenshots / Demo (if applicable)

‎.github/SECURITY.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you discover a security vulnerability, **do not create a public GitHub issue or discussion.**
6+
7+
Instead, report it privately using this repository�s [GitHub private vulnerability reporting tool](https://github.com/soenneker/soenneker.utils.autobogus/security/advisories/new).
8+
9+
When reporting, include as much detail as possible to help us triage effectively:
10+
- A description of the vulnerability and its context
11+
- Clear reproduction steps (if applicable)
12+
- Relevant logs, configs, or code snippets
13+
- Your assessment of potential impact or severity
14+
15+
We aim to respond within **2 business days**, and will work with you to assess and resolve the issue promptly. If a fix requires more time, we�ll provide regular status updates until it�s resolved.
16+
17+
## Disclosure Policy
18+
19+
Once a vulnerability is confirmed and fixed:
20+
- We may publish a GitHub Security Advisory
21+
- You will be credited as the reporter (unless you request anonymity)
22+
- A patch release and changelog update will follow
23+
24+
We follow [Coordinated Vulnerability Disclosure](https://vuls.cert.org/confluence/display/CVD) best practices; working privately with reporters to verify, fix, and only publicly disclose security issues once a safe resolution is in place.
25+
26+
## Security Best Practices
27+
28+
For your safety when using this project:
29+
- Use the latest release
30+
- Keep dependencies updated
31+
- Avoid exposing secrets or internal APIs
32+
- Apply least-privilege principles when integrating or deploying

0 commit comments

Comments
 (0)