Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (35 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

55 lines (35 loc) · 2.32 KB
Raw

Contributing to FluidVoice

Thanks for taking the time to improve FluidVoice. This repository keeps GitHub Issues focused on actionable work, and uses Discussions for questions, ideas, and early design conversations.

Start with Discussions

Start a GitHub Discussion first when you want to:

  • Ask a support question.
  • Propose a broad idea or feature.
  • Explore a design direction.
  • Report behavior that you are not sure is a FluidVoice bug.
  • Ask whether a change would be accepted before writing code.

Feature ideas should usually begin in the Ideas discussion category. Maintainers may turn an accepted or prioritized discussion into a tracked issue.

Issues

Issues are for work that maintainers can triage and act on.

Use a bug issue only when you can provide:

  • A clear description of the bug.
  • Exact reproduction steps.
  • Expected behavior and actual behavior.
  • FluidVoice version, macOS version, and architecture.
  • Logs, crash reports, screenshots, or recordings when relevant.

Feature issues show guidance to start with Discussions first, but this is advisory for now. Maintainers may still redirect broad or unclear feature ideas to Discussions during triage.

Incomplete bug reports may be labeled needs reproduction. If the missing reproduction details are not provided after 14 days, the issue may be closed.

Pull Requests

Pull requests should be tied to an accepted issue, Discussion, or roadmap item. Before opening a PR:

  • Fill out every required section of the PR template.
  • Select a type of change.
  • Link the related issue or accepted Discussion.
  • Describe how you tested the change.
  • Attach screenshots or video for UI, UX, settings, onboarding, overlay, menu bar, or visual behavior changes.

If a PR has no UI or visual behavior changes, check the "No UI/visual changes" box in the template. The PR Policy workflow still requires screenshots or video when changed files touch visual surfaces.

PRs that do not follow the template will be blocked by the PR Policy check. If required information is still missing after 48 hours, the PR may be closed so maintainers can keep review queues focused.

Repository Settings

Maintainers should enable GitHub Discussions with these categories:

  • Ideas
  • Help
  • General

Maintainers should require the existing build/test check and the PR Policy check before merging to main.