Community files

Author: Jake Soenneker

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,22 @@
+# Code of Conduct
+
+We are committed to creating a respectful, inclusive, and harassment-free environment for everyone.
+
+## Expected Behavior
+
+* Be kind, considerate, and professional.
+* Welcome diverse perspectives and experiences.
+* Offer and accept constructive feedback with grace.
+
+## Unacceptable Behavior
+
+* Harassment, abuse, or discrimination of any kind
+* Personal attacks, insults, or inflammatory remarks
+* Sharing private information without explicit consent
+
+## Reporting and Enforcement
+
+If you experience or witness unacceptable behavior, please report it by emailing [[email protected]](mailto:[email protected]).
+All reports will be reviewed promptly, kept confidential, and handled with care.
+
+This project adheres to the [Contributor Covenant](https://www.contributor-covenant.org), the most widely adopted standard for open source communities.

.github/CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing to Soenneker.Utils.BackgroundQueue
+
+We're excited that you're interested in contributing!
+
+## How to Contribute
+
+1. **Create an Issue**
+   - If you have a new feature idea, a bug report, or any other improvement suggestion, start by creating an issue on the [Issues](https://github.com/soenneker/soenneker.utils.backgroundqueue/issues) page.
+   - Clearly describe the problem or enhancement you're proposing and provide as much detail as possible.
+
+1. **Fork the Repository**
+   - If you want to work on a feature or bug fix, fork the repository's `main` branch to your GitHub account.
+
+1. **Create a Branch**
+   - Create a new branch for your contribution. Use a descriptive name that reflects the purpose of your changes.
+
+1. **Make Changes**
+   - If you've changed APIs, update the documentation.
+   - If you've added code that should be tested, add tests.
+   - Be sure to follow the coding conventions and guidelines of the project.
+
+1. **Test Your Changes**
+   - Test your changes thoroughly to ensure that they work as expected.
+
+1. **Commit Changes**
+   - Commit your changes with a clear and concise commit message.
+
+1. **Push Changes**
+   - Push your changes to your forked repository on GitHub.
+
+1. **Create a Pull Request**
+   - Go to the [Pull Requests](https://github.com/soenneker/soenneker.utils.backgroundqueue/pulls) page of the original repository.
+   - Click on "New Pull Request."
+   - Select your forked repository and the branch with your changes.
+   - Provide a clear title and description. Include the link of the original issue.
+
+1. **Code Review**
+   - Your pull request will be reviewed by the maintainers.
+   - Be responsive to any feedback and make necessary changes.
+   - Once your pull request is approved, it will be merged into the main branch.
+
+## Sponsor us
+
+If you don't have the time or expertise to contribute code, you can still support us by [sponsoring](https://github.com/sponsors/soenneker).

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,37 @@
+name: 🐛 Bug Report
+description: Report a problem
+title: "[Bug]: "
+labels: [bug]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: What’s the issue?
+      description: Describe the unexpected behavior and what should happen instead
+      placeholder: "I'm using X method, but it throws Y..."
+      required: true
+
+  - type: textarea
+    id: repro
+    attributes:
+      label: Reproduction steps
+      description: Code snippets or steps to reproduce the issue
+      placeholder: |
+        1. Use this input...
+        2. Call this method...
+        3. Get this result...
+      required: true
+
+  - type: textarea
+    id: env
+    attributes:
+      label: Environment
+      description: .NET version, library version, OS, runtime
+      placeholder: ".NET 8, Windows 11, library v1.2.3"
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Stack trace or error
+      description: Paste any logs or exceptions
+      render: shell

.github/ISSUE_TEMPLATE/documentation.yml

@@ -0,0 +1,23 @@
+name: 📝 Documentation Update
+description: Suggest improvements to README, XML docs, or usage examples
+title: "[Docs]: "
+labels: [documentation]
+body:
+  - type: textarea
+    id: section
+    attributes:
+      label: Where’s the issue?
+      description: What part of the documentation is unclear or missing?
+      placeholder: "The usage section for X is missing how to configure Y..."
+
+  - type: textarea
+    id: suggestion
+    attributes:
+      label: Suggestion
+      description: What would clarify it?
+
+  - type: textarea
+    id: notes
+    attributes:
+      label: Context
+      description: Anything else that would help improve it?

.github/ISSUE_TEMPLATE/feature.yml

@@ -0,0 +1,25 @@
+name: ✨ Feature Request
+description: Suggest an improvement
+title: "[Feature]: "
+labels: [enhancement]
+body:
+  - type: textarea
+    id: proposal
+    attributes:
+      label: What should be added?
+      description: Describe the new feature, method, or behavior
+      placeholder: "It would help to have a method that..."
+
+  - type: textarea
+    id: usecase
+    attributes:
+      label: What’s the use case?
+      description: What developer problem does this solve?
+      placeholder: "This would help when building..."
+
+  - type: textarea
+    id: api
+    attributes:
+      label: Suggested API (optional)
+      description: If applicable, propose a sample method, interface, or signature
+      placeholder: "Maybe something like: `DoThingAsync(MyOptions options)`"

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,34 @@
+<!-- Pull Request Template -->
+
+## Description
+
+Please include a summary of the changes and the related issue. 
+Clearly describe the problem and how this PR addresses it.
+
+Fixes: #<issue-number> (if applicable)
+
+---
+
+## Type of Change
+
+Please delete options that are not relevant.
+
+- [ ] 🐛 Bug fix
+- [ ] ✨ New feature
+- [ ] 🔧 Refactor
+- [ ] 📝 Documentation update
+- [ ] ✅ Test improvement
+- [ ] 🔁 Chore / Maintenance
+
+---
+
+## Checklist
+
+- [ ] I’ve added/updated necessary tests
+- [ ] I’ve added/updated documentation
+- [ ] My code follows the code style of this project
+- [ ] I’ve tested this manually
+
+---
+
+## Screenshots / Demo (if applicable)

.github/SECURITY.md

@@ -0,0 +1,32 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability, **do not create a public GitHub issue or discussion.**
+
+Instead, report it privately using this repository�s [GitHub private vulnerability reporting tool](https://github.com/soenneker/soenneker.utils.backgroundqueue/security/advisories/new).
+
+When reporting, include as much detail as possible to help us triage effectively:
+- A description of the vulnerability and its context
+- Clear reproduction steps (if applicable)
+- Relevant logs, configs, or code snippets
+- Your assessment of potential impact or severity
+
+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.
+
+## Disclosure Policy
+
+Once a vulnerability is confirmed and fixed:
+- We may publish a GitHub Security Advisory
+- You will be credited as the reporter (unless you request anonymity)
+- A patch release and changelog update will follow
+
+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.
+
+## Security Best Practices
+
+For your safety when using this project:
+- Use the latest release
+- Keep dependencies updated
+- Avoid exposing secrets or internal APIs
+- Apply least-privilege principles when integrating or deploying