Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (35 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

53 lines (35 loc) · 1.46 KB

Contributing to IntoError

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

Reporting Bugs

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

  • A clear, descriptive title
  • Steps to reproduce the issue
  • Expected behavior vs actual behavior
  • Swift version and platform information
  • Minimal code example if possible

Suggesting Features

Feature requests are welcome! Please open an issue with:

  • A clear description of the feature
  • Use cases and motivation
  • Any implementation ideas you may have

Pull Request Process

  1. Fork the repository and create your branch from master
  2. Make your changes and ensure tests pass
  3. Add tests for any new functionality
  4. Update documentation if needed
  5. Submit a pull request with a clear description of your changes

PR Guidelines

  • Keep changes focused and atomic
  • Follow existing code patterns
  • Ensure all tests pass before submitting

Code Style

This project follows Swift conventions. Please reference .swift-format for formatting guidelines.

Key points:

  • Keep lines reasonably short
  • Use meaningful variable and function names

Testing Requirements

All contributions should include appropriate tests:

  • Run existing tests with swift test
  • Add unit tests for new functionality
  • Ensure macro expansions are tested with assertMacroExpansion

Thank you for contributing!