This guide will help you set up your development environment and understand the process for contributing code to lume.
Lume development requires:
- Swift 6 or higher
- Xcode 15 or higher
- macOS Sequoia 15.2 or higher
- (Optional) VS Code with Swift extension
- Fork the Repository: Create your own fork of lume
- Clone the Repository:
git clone https://github.com/trycua/lume.git cd lume
- Install Dependencies:
swift package resolve
- Build the Project:
swift build
- Create a new branch for your changes
- Make your changes
- Run the tests:
swift test
- Build and test your changes locally
- Commit your changes with clear commit messages
- Push your changes to your fork
- Open a Pull Request with:
- A clear title and description
- Reference to any related issues
- Screenshots or logs if relevant
- Respond to any feedback from maintainers