diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 00000000..655b058c --- /dev/null +++ b/.editorconfig @@ -0,0 +1,12 @@ +root = true + +[*] +indent_style = space +indent_size = 4 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[*.{yml,yaml,json,md}] +indent_size = 2 diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..1f355c06 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,44 @@ +name: "🐛 Bug Report" +description: "Report a bug or transcription error in FluidVoice" +title: "[Bug]: " +labels: ["bug", "triage"] +body: + - type: markdown + attributes: + value: | + Please fill out this form to help us diagnose the transcription or UI issue. + - type: textarea + id: description + attributes: + label: "Bug Description" + description: "A clear description of what the issue is." + placeholder: "e.g., Application crashes when dictation key is pressed..." + validations: + required: true + - type: dropdown + id: os_version + attributes: + label: "macOS Version" + options: + - macOS 15 Sequoia + - macOS 14 Sonoma + - macOS 13 Ventura + - Other (specify in details) + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: "Reproduction Steps" + description: "How can we reproduce the error?" + placeholder: | + 1. Open FluidVoice... + 2. Press custom trigger shortcut... + 3. App crashes... + validations: + required: true + - type: textarea + id: logs + attributes: + label: "Logs and Crash Reports" + render: shell diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..fb101dac --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,17 @@ +name: "🚀 Feature Request" +description: "Suggest a new capability, enhancement, or language model support" +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + We are happy to receive suggestions to make FluidVoice a better local dictation app. + - type: textarea + id: details + attributes: + label: "Proposed Feature Details" + description: "What new shortcut, formatting capability, or model enhancement should be added?" + placeholder: "Add custom formatting shortcuts for Markdown editors..." + validations: + required: true diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..33739459 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,55 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best for the overall community, not just for us as + individuals + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and unwelcome sexual attention or + advances +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. + +## Reporting & Contact + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the repository owners. All complaints will be reviewed and investigated +promptly and fairly. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..d39a0d70 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,17 @@ +# Security Policy + +## On-Device Privacy Commitment + +FluidVoice operates entirely locally. Your audio recordings, transcripts, and model configurations never leave your machine. + +## Supported Versions + +Only the latest stable release on the `main` branch is supported with security updates. + +## Reporting a Vulnerability + +If you identify a security vulnerability (such as memory corruption issues in custom llama.cpp modules, local privilege escalations, or audio capture leaks), please do **not** open a public issue. + +Please report vulnerabilities privately by emailing the repository owner or using GitHub's private vulnerability reporting feature. + +We will review your submission and release a patch swiftly.