From 258d0a86ed752a100301143fec65c15c55a8aed1 Mon Sep 17 00:00:00 2001 From: saagpatel Date: Sun, 29 Mar 2026 03:26:56 -0700 Subject: [PATCH] docs: add CONTRIBUTING, SECURITY, and Dependabot config --- .github/dependabot.yml | 10 ++++++++++ CONTRIBUTING.md | 19 +++++++++++++++++++ SECURITY.md | 14 ++++++++++++++ 3 files changed, 43 insertions(+) create mode 100644 .github/dependabot.yml create mode 100644 CONTRIBUTING.md create mode 100644 SECURITY.md diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..782a0ad --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,10 @@ +version: 2 +updates: + - package-ecosystem: "npm" + directory: "/" + schedule: + interval: "weekly" + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7f7129e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Contributing + +Thank you for your interest in contributing! + +## Getting Started + +1. Fork the repository +2. Create a feature branch: `git checkout -b feat/your-feature` +3. Make your changes +4. Commit using [Conventional Commits](https://www.conventionalcommits.org/): `feat:`, `fix:`, `chore:`, etc. +5. Push and open a pull request + +## Reporting Issues + +Open a [GitHub Issue](../../issues) with a clear description and steps to reproduce. + +## Code Style + +Follow the existing conventions in the codebase. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..f51e103 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,14 @@ +# Security Policy + +## Reporting a Vulnerability + +Please **do not** open a public GitHub issue for security vulnerabilities. + +Open a [GitHub Security Advisory](../../security/advisories/new) or email the maintainer directly. + +Include: +- Description of the vulnerability +- Steps to reproduce +- Potential impact + +You will receive a response within 72 hours.