From 039979d1fa20016859f6ee9f74f7efd0878c98a5 Mon Sep 17 00:00:00 2001 From: "https://github.com/jbisaccia-9" <265838760+jbisaccia-9@users.noreply.github.com> Date: Fri, 28 Aug 2026 10:06:31 -0700 Subject: [PATCH] Add CONTRIBUTING, CODE_OF_CONDUCT, issue/PR templates --- .github/ISSUE_TEMPLATE.md | 7 +++++++ .github/PULL_REQUEST_TEMPLATE.md | 8 ++++++++ CODE_OF_CONDUCT.md | 23 +++++++++++++++++++++++ CONTRIBUTING.md | 24 ++++++++++++++++++++++++ 4 files changed, 62 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..cde0d23 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,7 @@ +## What's the issue or request? + +## Steps to reproduce (if a bug) + +## Expected vs. actual behavior + +## Would you like to work on this yourself? diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..d156869 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,8 @@ +## What does this change? + +## Why? + +## Checklist +- [ ] Gate/eval suite still passes locally +- [ ] Any threshold change is in config, with a reason in this PR description +- [ ] No real PII, credentials, or proprietary data added diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..9540303 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,23 @@ +# Code of Conduct + +## Our pledge + +We as contributors and maintainers pledge to make participation in this project a harassment-free experience for everyone, regardless of experience level, background, or identity. + +## Our standards + +Examples of behavior that contributes to a positive environment: +- Being respectful of differing viewpoints and experiences +- Giving and gracefully accepting constructive feedback +- Focusing on what is best for the project and community + +Examples of unacceptable behavior: +- Harassment, insults, or derogatory comments +- Publishing others' private information without permission +- Other conduct which could reasonably be considered inappropriate in a professional setting + +## Enforcement + +Instances of unacceptable behavior may be reported by opening a GitHub issue or contacting the maintainer through their GitHub profile. All complaints will be reviewed and investigated. + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..748b7b6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contributing + +Thanks for considering a contribution. This repo is part of a small family of "-gate" projects that each enforce one measured bar before letting something ship — please keep contributions in that spirit. + +## Ground rules + +- **The gate must still pass.** Every PR needs to pass the existing gate/eval suite (CI on this repo). Making the gate stricter or changing what it measures is welcome — but the gate itself has to still run and produce a real pass/fail. +- **Threshold changes go in config, with a reason.** If you're proposing a change to a pass/fail threshold (a recall bar, a kappa minimum, a spend cap, etc.), change it in the config file where it lives, not by hardcoding a new number inline — and explain *why* in the PR description. +- **Data stays synthetic.** All fixtures, golden sets, and example data in this repo are synthetic or public-domain. Don't add real PII, real credentials, real account data, or anything proprietary. + +## Getting started + +1. Fork the repo and clone your fork. +2. Follow the Quickstart in the README to get a working local environment (no API key required for the base path). +3. Run the test suite and the gate locally before opening a PR — both should be green (or, for a deliberately-failing example, fail for the expected reason). +4. Open a PR against `main`. Small, focused PRs are easier to review than large ones. + +## Good first issues + +Issues labeled `good first issue` are scoped to be approachable without deep context on the rest of the repo. `help wanted` issues are open to anyone. + +## Code of conduct + +This project follows the [Code of Conduct](CODE_OF_CONDUCT.md).