diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 25f0bc5ed8..e383313452 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -1,31 +1,24 @@ --- -name: 🐛 Bug Report -about: Thank you for taking the time, please report a reproducible bug -title: "[Bug] " +name: Bug report +about: Report a reproducible bug in Buzz labels: bug -assignees: add codeowner's @name here - --- **Describe the bug** -*A clear and concise description of what the bug is.* +A clear and concise description of what the bug is. -**To Reproduce:** -*Steps to reproduce the behavior:* +**Steps to reproduce** 1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior:** -*A clear and concise description of what you expected to happen.* +2. Click on '...' +3. See error -**Supporting Material** -*If applicable, add screenshots, output log and/or other documentation to help explain your problem.* +**Expected behavior** +What did you expect to happen? -**Environment (please complete the following information):** - - OS: [ex: iOS] - - Version +**Version and platform** +Find your version at the bottom of the Settings sidebar. Write "unknown" if you can't determine it. +- Buzz version: +- OS: -**Additional context** -Add any other context that you feel is relevant about the problem here. +**Logs / additional context** +Paste any relevant logs, error messages, or screenshots here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 0ba9db2532..0086358db1 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1 @@ -contact_links: - - name: ❓ Questions and Help 🤔 - url: https://discord.gg/block-opensource (/add your discord channel if applicable) - about: This issue tracker is not for support questions. Please refer to the community for more help. +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 0000000000..ba5132f0e3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,21 @@ +--- +name: Feature request +about: Propose a new feature or improvement +labels: enhancement +--- + +**Motivation** +What problem does this solve? Who runs into it and when? + +**Proposed solution** +Describe what you'd like to see. + +**Alternatives considered** +What other approaches did you consider? + +**Additional context** +Anything else that helps — links, screenshots, prior art. + +--- + +Before opening: please [search open issues and PRs](https://github.com/block/buzz/issues?q=is%3Aopen) for duplicates — link the closest one, or say "none found". diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..325a485102 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,8 @@ +## Summary + + +### Related issue + + +### Testing + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d6278f5eba..565d740129 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,24 +4,24 @@ Welcome, and thank you for your interest in contributing! Buzz is an open-source project and we're glad you're here. This guide will help you get from zero to a merged pull request. -If you have questions that aren't answered here, open a GitHub Discussion or -reach out in the community channels. +If you have questions that aren't answered here, [open an issue](https://github.com/block/buzz/issues/new). --- ## Table of Contents 1. [Code of Conduct](#code-of-conduct) -2. [Setting Up the Development Environment](#setting-up-the-development-environment) -3. [Running Tests](#running-tests) -4. [Code Style](#code-style) -5. [Making a Pull Request](#making-a-pull-request) -6. [Architecture Overview](#architecture-overview) -7. [Ecosystem](#ecosystem) -8. [How to Add a New Event Kind](#how-to-add-a-new-event-kind) -9. [How to Add a New MCP Tool](#how-to-add-a-new-mcp-tool) -10. [How to Add a New API Endpoint](#how-to-add-a-new-api-endpoint) -11. [License and CLA](#license-and-cla) +2. [Before You Open a PR](#before-you-open-a-pr) +3. [Setting Up the Development Environment](#setting-up-the-development-environment) +4. [Running Tests](#running-tests) +5. [Code Style](#code-style) +6. [Making a Pull Request](#making-a-pull-request) +7. [Architecture Overview](#architecture-overview) +8. [Ecosystem](#ecosystem) +9. [How to Add a New Event Kind](#how-to-add-a-new-event-kind) +10. [How to Add a New MCP Tool](#how-to-add-a-new-mcp-tool) +11. [How to Add a New API Endpoint](#how-to-add-a-new-api-endpoint) +12. [License and CLA](#license-and-cla) --- @@ -33,6 +33,20 @@ unacceptable behavior to **conduct@buzz-relay.org**. --- +## Before You Open a PR + +Before starting, search [open PRs](https://github.com/block/buzz/pulls) and [open issues](https://github.com/block/buzz/issues) for duplicates — someone may already be working on the same thing. When you open your PR, link the closest existing one in the description (or say "none found"). + +For anything beyond a small fix, opening an issue first is strongly recommended. Describe the problem and proposed solution so a maintainer can acknowledge the approach before you build — it avoids two people building the same thing in parallel. + +Buzz is an agent platform, so AI-assisted PRs are welcome. No need to disclose the tools you used, but you own and must have reviewed the final code. Submissions that are clearly unreviewed may be closed with a pointer here. + +We squash-merge, so your PR title becomes the commit subject in `main`. Use [Conventional Commits](https://www.conventionalcommits.org/) format: `feat(mcp): add get_feed_actions tool`. The type prefix (`feat`, `fix`, `docs`, `refactor`, `test`, `chore`) is required. See the [Commit Messages](#commit-messages) section for the full reference. + +We review as capacity allows — focused PRs that follow this guide move fastest. + +--- + ## Setting Up the Development Environment ### Prerequisites @@ -248,13 +262,6 @@ required. The scope (in parentheses) is optional but encouraged. ## Making a Pull Request -### Before You Start - -- Check open issues and PRs to avoid duplicate work. -- For significant changes, open an issue first to discuss the approach. -- For small fixes (typos, doc improvements, obvious bugs), go ahead and open - a PR directly. - ### What a Good PR Looks Like 1. **Focused** — one logical change per PR. If you're fixing a bug and @@ -275,19 +282,9 @@ required. The scope (in parentheses) is optional but encouraged. - How to test it manually (if applicable) - Any follow-up work deferred to a future PR -### PR Checklist - -``` -- [ ] `just ci` passes (fmt + clippy + unit tests + mobile) -- [ ] Integration tests pass (`just test`) -- [ ] New public APIs / tools / endpoints are documented -- [ ] No new `unwrap()` in production code paths -- [ ] No new `unsafe` blocks -``` - ### Review Process -- A maintainer will review your PR within a few business days. +- We prioritize focused PRs that follow this guide and review as capacity allows. - Address review comments by pushing new commits (don't force-push during review; it makes it hard to see what changed). - Once approved, a maintainer will squash-merge your PR.