Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (55 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

80 lines (55 loc) · 2.68 KB

Contributing to SwiftRouter

First off, thank you for considering contributing to SwiftRouter! It's people like you that make SwiftRouter such a great tool.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the existing issues as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include Swift version and OS version

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:

  • Use a clear and descriptive title
  • Provide a step-by-step description of the suggested enhancement
  • Provide specific examples to demonstrate the steps
  • Describe the current behavior and explain which behavior you expected to see instead
  • Explain why this enhancement would be useful

Pull Requests

  1. Fork the repo and create your branch from main
  2. If you've added code that should be tested, add tests
  3. If you've changed APIs, update the documentation
  4. Ensure the test suite passes
  5. Make sure your code follows the existing style (SwiftLint)
  6. Issue that pull request!

Development Setup

# Clone your fork
git clone https://github.com/YOUR_USERNAME/SwiftRouter.git

# Navigate to the project
cd SwiftRouter

# Open in Xcode
open Package.swift

# Run tests
swift test

Style Guide

Commit Messages

We follow the Conventional Commits specification:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Code style changes (formatting, semicolons, etc)
  • refactor: Code change that neither fixes a bug nor adds a feature
  • test: Adding missing tests
  • chore: Changes to the build process or auxiliary tools

Example: feat(deeplink): add universal link support

License

By contributing, you agree that your contributions will be licensed under the MIT License.