From 0d575c4473de833dc2dcf5f730a86754fc11a832 Mon Sep 17 00:00:00 2001 From: Paul Gardiner Date: Fri, 20 Mar 2026 08:58:53 +0000 Subject: [PATCH] feat: adding contribution details as well as updating the templates for pull requests, bugs and feature requests. --- .github/CODEOWNERS | 2 + .github/FUNDING.yml | 1 + .github/ISSUE_TEMPLATE/bug_report.md | 36 +++++----- .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/feature_request.md | 8 +-- .github/pull_request_template.md | 19 +++++ CONTRIBUTING.md | 87 +++++++++++++++++++++++ 7 files changed, 134 insertions(+), 24 deletions(-) create mode 100644 .github/CODEOWNERS create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/pull_request_template.md create mode 100644 CONTRIBUTING.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..8a989d5 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,2 @@ +# Default owners for everything in the repo +* @mooncitizen diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..265c36e --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +github: [lag-app] diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index ca3af5a..478ca71 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,8 +1,8 @@ --- name: Bug report -about: Create a report to help us improve -title: "[BUG]" -labels: '' +about: Report a bug to help us improve Lag CLI +title: "[BUG] " +labels: bug assignees: mooncitizen --- @@ -12,27 +12,23 @@ A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +1. Run `lag ...` +2. See error **Expected behavior** A clear and concise description of what you expected to happen. -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] +**Terminal output** +If applicable, paste the relevant terminal output or error messages. Use debug logging for more detail: +```bash +RUST_LOG=debug lag +``` + +**Environment:** + - OS: [e.g. macOS 15.2, Ubuntu 24.04] + - Architecture: [e.g. arm64, x86_64] + - Lag CLI version: [e.g. 0.0.8-alpha — run `lag --version`] + - Installation method: [e.g. Homebrew, curl install script, from source] **Additional context** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..0c7eae3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Lag Website + url: https://trylag.com + about: Visit the Lag website for more information diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7..7e71c9d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,9 +1,9 @@ --- name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' +about: Suggest an idea for Lag CLI +title: "" +labels: enhancement +assignees: "" --- diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..714a220 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,19 @@ +## Summary + + + +## Changes + +- + +## How to test + + + +1. + +## Checklist + +- [ ] Code compiles without warnings (`cargo build --workspace`) +- [ ] Tests pass (`cargo test --workspace`) +- [ ] I have tested this on my platform (macOS / Linux) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c12b150 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,87 @@ +# Contributing to Lag CLI + +Thanks for your interest in contributing! We're a small team so PR reviews may take some time, but we appreciate every contribution. + +## Getting Started + +1. Fork the repository +2. Clone your fork: + ```bash + git clone https://github.com//cli.git + cd cli + ``` +3. Create a branch for your changes: + ```bash + git checkout -b my-feature + ``` + +## Development Setup + +You'll need: +- [Rust](https://rustup.rs/) (stable toolchain) +- A C compiler (for native dependencies) +- CMake (for audio library builds) + +Build and run: +```bash +cargo build -p lag-cli +cargo run -p lag-cli -- --help +``` + +Run tests: +```bash +cargo test --workspace +``` + +Enable debug logging: +```bash +RUST_LOG=debug cargo run -p lag-cli -- +``` + +Point to a local API server for development: +```bash +lag config set api-url http://localhost:3001 +``` + +## Project Structure + +``` +crates/ + cli/ # Main CLI application + common/ # Shared types and utilities + voice-core/ # Voice chat engine +``` + +## Making Changes + +- Keep PRs focused — one feature or fix per PR +- Follow existing code style and conventions +- Make sure `cargo build --workspace` compiles without warnings +- Make sure `cargo test --workspace` passes +- Test your changes on your platform (macOS or Linux) + +## Commit Messages + +Write clear, concise commit messages. Use the imperative mood: +- `fix: handle expired token on reconnect` +- `feat: add push-to-talk toggle command` +- `docs: update install instructions for arm64` + +## Submitting a Pull Request + +1. Push your branch to your fork +2. Open a PR against `main` +3. Fill out the PR template +4. Wait for review — we'll get to it as soon as we can + +## Reporting Bugs + +Use the [bug report template](https://github.com/lag-app/cli/issues/new?template=bug_report.md). Include your OS, architecture, CLI version (`lag --version`), and steps to reproduce. + +## Requesting Features + +Use the [feature request template](https://github.com/lag-app/cli/issues/new?template=feature_request.md). + +## License + +By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE).