diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 862b920..3b38bc5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,24 +1,10 @@ # Contributing -First off — thanks for being here. If you're reading this, you're either using the adapter or thinking about improving it, and either way we're glad you showed up. +Thanks for helping make the adapter better. Issues and PRs are the main way it improves, and they're genuinely welcome. -Before anything else, one honest note about what this project is and isn't. +## How this project is supported -## The deal (please read this first) - -**bw-voice-adapter is a best-effort, community-supported project — not a fully supported Bandwidth product.** - -There's no team staffed on this full-time. It was built to solve a real problem well, and it's proven on real calls, but nobody is on the hook for a support SLA, a release schedule, or a guaranteed response time. We want to be upfront about that so your expectations and ours line up from day one. - -What that means in practice: - -- **Open an issue or put up a PR — genuinely, please do.** That's exactly how this project stays useful. A Bandmate will take a look when they're able to. -- **Response times will vary.** Could be a day, could be longer, depending on what else is on people's plates. It's not indifference — it's just that this isn't anyone's dedicated job. -- **No promises on prioritization.** We can't commit to fixing a given bug or shipping a given feature on any particular timeline. If something is blocking you, the fastest path is often a PR you drive yourself, with us helping review. - -If you need guaranteed, SLA-backed support for a production voice migration, that's a conversation to have with your Bandwidth account team — not this repo. - -None of this is meant to wave you off. Best-effort still means real effort. We'd just rather tell you the truth than let you find it out the hard way. +bw-voice-adapter is best-effort and community-supported — not a fully supported Bandwidth product. It's proven on real calls, but there's no team on it full-time, so response times vary and prioritization isn't guaranteed. If something's blocking you, the fastest path is usually a PR you drive yourself. For SLA-backed support on a production migration, talk to your Bandwidth account team. ## How to report a problem @@ -53,8 +39,8 @@ Open a GitHub issue with enough for someone to reproduce it without a back-and-f - It's **scoped** — one focused change per PR beats a sprawling one. - It updates the **docs** (README capability tables especially) when it changes what the adapter can do. -## A realistic word on review +## What to expect on review -Because this is best-effort, review may take a while, and a maintainer might ask you to carry a change further than you expected — more tests, a doc update, a tweak to the matrix. It's not us being precious; it's the bar that keeps this thing trustworthy on live calls. Thanks in advance for your patience with that. +Review may take a while, and a maintainer might ask you to carry a change further than you expected — more tests, a doc update, a tweak to the matrix. That bar is what keeps the adapter trustworthy on live calls. -Seriously — thank you for contributing. Every good issue and every solid PR makes this more useful for the next person trying to move a voice app without rewriting it. +Thanks for contributing. Every solid issue and PR makes this more useful for the next person moving a voice app without rewriting it.