Merge pull request #2 from gonzalezreal/prepare-for-release

Prepare for first release

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,83 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,73 @@
+name: Bug Report
+description: Something isn't working as expected
+labels: [bug]
+body:
+- type: markdown
+  attributes:
+    value: |
+      Thank you for contributing to SwiftUIMath!
+
+      Before you submit your issue, please complete each text area below with the relevant details for your bug, and complete the steps in the checklist.
+- type: textarea
+  attributes:
+    label: Description
+    description: |
+      A short description of the incorrect behavior.
+
+      If you think this issue has been recently introduced and did not occur in an earlier version, please note that. If possible, include the last version that the behavior was correct in addition to your current version.
+  validations:
+    required: true
+- type: checkboxes
+  attributes:
+    label: Checklist
+    options:
+    - label: I have determined whether this bug is also reproducible in a vanilla SwiftUI project.
+      required: false
+    - label: If possible, I've reproduced the issue using the `main` branch of this package.
+      required: false
+    - label: This issue hasn't been addressed in an [existing GitHub issue](https://github.com/gonzalezreal/swiftui-math/issues) or [discussion](https://github.com/gonzalezreal/swiftui-math/discussions).
+      required: true
+- type: textarea
+  attributes:
+    label: Expected behavior
+    description: Describe what you expected to happen.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Actual behavior
+    description: Describe or copy/paste the behavior you observe.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Steps to reproduce
+    description: |
+      Explanation of how to reproduce the incorrect behavior.
+
+      This could include an attached project or link to code that is exhibiting the issue, and/or a screen recording.
+    placeholder: |
+      1. ...
+  validations:
+    required: false
+- type: input
+  attributes:
+    label: SwiftUIMath version information
+    description: The version of SwiftUIMath used to reproduce this issue.
+    placeholder: "'0.1.0' for example, or a commit hash"
+- type: input
+  attributes:
+    label: Destination operating system
+    description: The OS running your application.
+    placeholder: "'iOS 18' or 'macOS 15' for example"
+- type: input
+  attributes:
+    label: Xcode version information
+    description: The version of Xcode used to reproduce this issue.
+    placeholder: "The version displayed from 'Xcode > About Xcode'"
+- type: textarea
+  attributes:
+    label: Swift Compiler version information
+    description: The version of Swift used to reproduce this issue.
+    placeholder: Output from 'xcrun swiftc --version'
+    render: shell

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,9 @@
+blank_issues_enabled: false
+
+contact_links:
+  - name: Discussion
+    url: https://github.com/gonzalezreal/swiftui-math/discussions
+    about: SwiftUIMath Q&A, ideas, and feature requests
+  - name: Documentation
+    url: https://swiftpackageindex.com/gonzalezreal/swiftui-math/main/documentation/swiftuimath
+    about: Read documentation for SwiftUIMath

.github/workflows/ci.yml

@@ -0,0 +1,55 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '**.md'
+      - 'LICENSE*'
+      - '.gitignore'
+      - '.editorconfig'
+      - '**.gif'
+      - '**.png'
+      - '**.jpg'
+  pull_request:
+    branches:
+      - '*'
+    paths-ignore:
+      - '**.md'
+      - 'LICENSE*'
+      - '.gitignore'
+      - '.editorconfig'
+      - '**.gif'
+      - '**.png'
+      - '**.jpg'
+  workflow_dispatch:
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: Test All Platforms
+    runs-on: macos-15
+    steps:
+      - uses: actions/checkout@v4
+      - name: Select Xcode 26.0
+        run: sudo xcode-select -s /Applications/Xcode_26.0.app
+      - name: Skip macro validation
+        run: defaults write com.apple.dt.Xcode IDESkipMacroFingerprintValidation -bool YES
+      - name: Run tests
+        run: make test
+
+  backward-compatibility:
+    name: Backward Compatibility (Xcode 16.4)
+    runs-on: macos-15
+    steps:
+      - uses: actions/checkout@v4
+      - name: Select Xcode 16.4
+        run: sudo xcode-select -s /Applications/Xcode_16.4.app
+      - name: Skip macro validation
+        run: defaults write com.apple.dt.Xcode IDESkipMacroFingerprintValidation -bool YES
+      - name: Test macOS
+        run: make test-macos

.github/workflows/format.yml

@@ -0,0 +1,27 @@
+name: Format
+
+on:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: format-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  swift_format:
+    name: swift-format
+    runs-on: macos-15
+    steps:
+      - uses: actions/checkout@v4
+      - name: Select Xcode 26.0
+        run: sudo xcode-select -s /Applications/Xcode_26.0.app
+      - name: Format
+        run: make format
+      - uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Run swift-format
+          branch: main
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.spi.yml

@@ -0,0 +1,4 @@
+version: 1
+builder:
+  configs:
+  - documentation_targets: [SwiftUIMath]

CONTRIBUTING.md

@@ -0,0 +1,132 @@
+# Contributing to SwiftUIMath
+
+Thank you for your interest in contributing to SwiftUIMath! We welcome contributions from the community and are grateful for any help you can provide.
+
+## Code of Conduct
+
+This project adheres to the [Contributor Covenant Code of Conduct](.github/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.
+
+## How to Contribute
+
+### Reporting Bugs
+
+Before submitting a bug report:
+- Check the existing issues to avoid duplicates
+- Verify you're using the latest version of SwiftUIMath
+
+When creating a bug report, include:
+- A clear and descriptive title
+- Steps to reproduce the issue
+- Expected behavior vs. actual behavior
+- Code samples or minimal reproduction cases
+- Screenshots or videos if applicable
+- Your environment (Xcode version, OS version, device/simulator)
+
+### Suggesting Enhancements
+
+We welcome feature requests and enhancement suggestions! Before submitting:
+- Check existing issues for similar suggestions
+- Consider if the feature aligns with SwiftUIMath's core goals
+
+When proposing an enhancement:
+- Provide a clear and descriptive title
+- Explain the problem you're trying to solve
+- Describe your proposed solution
+- Include code examples or mockups if applicable
+- Discuss any alternative solutions you've considered
+
+### Pull Requests
+
+1. **Fork the repository** and create your branch from `main`
+2. **Set up your development environment**:
+   - Open `Package.swift` at the repository root
+3. **Make your changes**:
+   - Write clear, self-documenting code
+   - Add tests for new functionality
+   - Update documentation as needed
+4. **Test your changes**:
+   - Run the test suite and verify all tests pass
+   - Test on multiple platforms (iOS, macOS, visionOS) if applicable
+5. **Commit your changes** with a descriptive commit message (see style guide below)
+6. **Push to your fork** and submit a pull request to the `main` branch
+
+## Development Setup
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/gonzalezreal/swiftui-math.git
+   cd swiftui-math
+   ```
+
+2. Open the package:
+   ```bash
+   open Package.swift
+   ```
+
+3. Build and run the tests to verify your setup
+
+## Style Guides
+
+### Git Commit Messages
+
+- Use the present tense ("Add feature" not "Added feature")
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+- Keep the first line concise (50 characters or less)
+- Reference issues and pull requests where appropriate
+- Use the body to explain what and why, not how
+
+Examples:
+- `Add Math view snapshot coverage`
+- `Fix line breaking for accented words`
+- `Improve typesetter performance`
+
+### Swift Code Style
+
+- Follow Swift API Design Guidelines
+- Use clear, descriptive names for types, methods, and variables
+- Prefer clarity over brevity
+- Use SwiftUI's declarative style and composition patterns
+- Keep view bodies focused and extract complex logic into separate methods or types
+- Document public APIs with clear, helpful comments
+- Use `// MARK:` comments to organize code into logical sections
+
+### Testing
+
+- Write tests for new functionality
+- Ensure existing tests continue to pass
+- Focus on testing public APIs and observable behavior
+- Include edge cases and error conditions
+- Keep tests focused and independent
+
+### Documentation
+
+- Update the README if you add user-facing features
+- Document public APIs with clear descriptions and examples
+- Include code examples in documentation when helpful
+- Update previews or snapshots to showcase new features
+
+## Additional Notes
+
+### Issue Labels
+
+We use labels to categorize issues and pull requests:
+- `bug` - Something isn't working
+- `enhancement` - New feature or request
+- `documentation` - Improvements or additions to documentation
+- `good first issue` - Good for newcomers
+- `help wanted` - Extra attention is needed
+
+### Questions?
+
+If you have questions about contributing, feel free to:
+- Open an issue with your question
+- Start a discussion in the repository
+- Review existing issues and pull requests for examples
+
+## Recognition
+
+Contributors are recognized in the project's commit history and release notes. Significant contributions may be highlighted in the README.
+
+---
+
+Thank you for contributing to SwiftUIMath! Your efforts help make this library better for everyone.