diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..0646c24 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,3 @@ +# Every change needs approval from the maintainer before it can merge into +# main (enforced by the branch ruleset's "require code owner review"). +* @bethvourc diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..97f51b9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,38 @@ +name: Question / help +description: Ask how to set up Iris or how to use a feature. +labels: [question] +body: + - type: markdown + attributes: + value: | + Happy to help! Before you ask, check the [README](https://github.com/bethvourc/iris#readme) + and the [docs](https://github.com/bethvourc/iris/tree/main/docs/desktop). Running + `./iris doctor` often points straight at the problem. + + Please **don't paste API keys, tokens, or personal data**. + - type: dropdown + id: topic + attributes: + label: What is this about? + options: + - Installation and setup + - macOS permissions + - Configuration (.env, providers, models) + - Using a feature (voice, screen, memory, connectors, …) + - macOS app + - Something else + validations: + required: true + - type: textarea + id: question + attributes: + label: Your question + description: What are you trying to do, and what have you tried so far? + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment (optional) + description: The output of `./iris doctor` and `./iris status` helps with setup questions. Redact anything sensitive. + render: text diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a2499e6..31dd4e5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -66,5 +66,12 @@ If the wire format between the app and the daemon changes, update 4. Add or update tests for any behavior you changed. 5. Update the README or `docs/` if you changed user-facing behavior. +`main` is protected. A PR can merge only when every CI check passes and the +maintainer has approved it. Pushing new commits after approval requires a fresh +review. Only the maintainer merges. + +Questions about setup or usage are welcome as issues. Pick the +**Question / help** template. + By contributing, you agree that your contributions are licensed under the [MIT License](LICENSE).