Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (40 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

55 lines (40 loc) · 1.92 KB
Raw

Contributing to Orchard

Thanks for your interest in improving Orchard! Contributions of all kinds are welcome — bug reports, feature ideas, documentation, and code.

Ways to contribute

  • Report a bug — open a bug report.
  • Request a feature — open a feature request.
  • Improve the docs — even small README/typo fixes are appreciated.
  • Submit code — see below.

Requirements

Getting started

git clone https://github.com/andrew-waters/orchard.git
cd orchard
open Orchard.xcodeproj

Xcode will resolve the apple/container Swift Package dependency on first build. Build and run the Orchard scheme, and run the tests with Product ▸ Test (⌘U), or from the command line:

xcodebuild test -project Orchard.xcodeproj -scheme Orchard -destination 'platform=macOS'

Pull requests

  1. Fork the repo and create a branch from main (e.g. fix/logs-scroll or feat/volume-picker).
  2. Keep changes focused — one logical change per PR is easiest to review.
  3. Match the existing code style; keep views small and composable.
  4. Make sure the project builds and the tests pass.
  5. Add a note to CHANGELOG.md under an Added / Changed / Fixed heading describing your change.
  6. Open the PR with a clear description of what changed and why. Include screenshots or a short clip for any UI change.

Reporting security issues

Please don't file public issues for security vulnerabilities — see SECURITY.md for how to report them privately.

Code of conduct

Be respectful and constructive. Harassment or abuse of any kind isn't welcome in this project's spaces.