-
-
Notifications
You must be signed in to change notification settings - Fork 372
Add repository standards: CODE_OF_CONDUCT, SECURITY policy, and interactive issues #501
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
shiva24082
wants to merge
5
commits into
altic-dev:main
from
shiva24082:improve/repository-standards
Closed
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
766fb0d
Add/Update CODE_OF_CONDUCT.md to improve repository standards
shiva24082 df16aa0
Add/Update SECURITY.md to improve repository standards
shiva24082 4690885
Add/Update .editorconfig to improve repository standards
shiva24082 7c7828a
Add/Update .github/ISSUE_TEMPLATE/bug_report.yml to improve repositor…
shiva24082 9d5019a
Add/Update .github/ISSUE_TEMPLATE/feature_request.yml to improve repo…
shiva24082 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This blanket statement is inaccurate when users enable the supported cloud AI enhancement path: README.md advertises OpenAI/Groq/custom providers, and the dictation flow folds the transcript into
userMessageContentbefore building anLLMClient.Configwith the providerbaseURLand sending it as a POST body viaURLSession(Sources/Fluid/ContentView.swiftlines 1866-1871 and 2007-2020;Sources/Fluid/Services/LLMClient.swiftlines 240-264). As written, the security policy tells privacy-sensitive users that transcripts never leave the machine even in a documented opt-in cloud-provider configuration, so it should mirror the README's "unless you opt in" caveat.Useful? React with 👍 / 👎.