Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (43 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

62 lines (43 loc) · 1.6 KB

Contributing to OwnAI

Thank you for your interest in contributing to OwnAI! We appreciate your help in making this project better.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue on our GitHub Issues page with:

  • A clear title and description
  • Steps to reproduce the bug
  • Expected behavior and what actually happened
  • System information (macOS version, Xcode version, etc.)
  • Screenshots if applicable

Feature Requests

Have an idea for a new feature? Open an issue on our GitHub Issues page with:

  • A clear title and description
  • The reason why this feature would be valuable
  • Any relevant examples or mockups

Pull Requests

  1. Fork the repository
  2. Create a new branch from main for your feature or bugfix
  3. Make your changes
  4. Ensure your code follows our style guidelines
  5. Test your changes thoroughly
  6. Submit a pull request

Development Setup

  1. Clone the repository

    git clone https://github.com/YourUsername/OwnAI.git
cd OwnAI

  2. Open the project in Xcode

    open ownai/ownai.xcodeproj

  3. Make your changes and test them locally

Style Guidelines

  • Follow Apple's Swift API Design Guidelines
  • Use SwiftUI best practices
  • Comment your code appropriately
  • Write meaningful commit messages

Code of Conduct

  • Be respectful and inclusive
  • Focus on constructive feedback
  • Help create a positive and collaborative environment

Thank you for contributing to OwnAI!