Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (22 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

33 lines (22 loc) · 1.72 KB
Raw

Contributing to MikuCode

Thanks for helping improve MikuCode. Contributions should make the macOS coding-agent workspace, local embedded terminal, or companion UI clearer, more reliable, or more accessible while keeping its focused one-panel scope.

This private repository requires a GitHub-authorized account for cloning and contributing.

Before opening an issue or pull request

  • Search existing issues and pull requests first.
  • For a feature, explain the user problem, proposed behavior, and why it fits the current scope.
  • For a bug, include macOS and Xcode/Swift versions, reproduction steps, expected behavior, actual behavior, and relevant logs. Remove secrets and private command output.
  • Do not include licensed or proprietary assets, including character models or artwork, unless redistribution rights are documented.

Development

Requirements and local commands are in README.md:

swift build
swift test
swift build -Xswiftc -warnings-as-errors
swift test -Xswiftc -warnings-as-errors

Keep changes focused. Add or update tests for behavior changes, avoid unrelated formatting churn, and do not commit build products, Xcode user data, or local terminal-session artifacts. Pull requests should describe the change, validation, accessibility impact, and known limitations.

Review and merge expectations

Pull requests need a clear description and passing CI before merge. Maintainers may request smaller commits, documentation updates, or additional tests. Please respond to review comments constructively and update the pull request rather than removing review context without explanation.

By contributing, you agree that your contributions are provided under the repository’s MIT License.