Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (39 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

58 lines (39 loc) · 1.93 KB
Raw

Contributing to SwiftRandomKit

Thank you for your interest in contributing to SwiftRandomKit! This document provides guidelines and instructions for contributing.

Code of Conduct

Please be respectful and considerate of others when contributing to this project.

How to Contribute

Reporting Bugs

  • Check if the bug has already been reported in the Issues
  • If not, create a new issue using the bug report template
  • Include a clear description and steps to reproduce

Suggesting Features

  • Check if the feature has already been suggested in the Issues
  • If not, create a new issue using the feature request template
  • Describe the feature and its potential benefits

Pull Requests

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Add or update tests as necessary
  5. Ensure all tests pass (swift test)
  6. Commit your changes (git commit -m 'Add amazing feature')
  7. Push to the branch (git push origin feature/amazing-feature)
  8. Open a Pull Request

Development Workflow

Setting Up the Development Environment

  1. Clone your fork of the repository
  2. Open the project in Xcode or your preferred IDE
  3. Run swift build to build the project
  4. Run swift test to ensure everything is working

Code Style Guidelines

  • Follow the Swift API Design Guidelines
  • Use meaningful variable and function names
  • Add documentation comments for public APIs
  • Keep functions small and focused on a single task

Testing

  • Write tests for all new features and bug fixes
  • Ensure all tests pass before submitting a pull request
  • Aim for high code coverage

License

By contributing to SwiftRandomKit, you agree that your contributions will be licensed under the project's MIT License.