Skip to content

Latest commit

 

History

History
62 lines (37 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

62 lines (37 loc) · 1.85 KB

Contributing to SSS

Thank you for your interest in contributing to SSS! This document provides guidelines for contributing to the project, whether you're reporting bugs, suggesting enhancements, or submitting code.

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct.

Getting Started

Prerequisites

  • Xcode 13
  • Swift 5.8
  • Git

Setting Up the Project

  1. Fork the repository on GitHub.
  2. Clone your fork: git clone https://github.com/eligutovsky/SyntacticSugar.git.
  3. Open the project in Xcode.

Reporting Bugs and Suggesting Enhancements

Please use the GitHub issues to report bugs and suggest enhancements. Be sure to include the following details:

  • A clear and concise description.
  • Steps to reproduce the issue.
  • Expected behavior.
  • Actual behavior.

Contributing Code

Creating a Branch

  1. Create a new branch for your feature or bug fix: git checkout -b feat/my-feature-branch.
  2. Make your changes.
  3. Commit your changes with a descriptive message.

Submitting a Pull Request

  1. Push your branch to your fork: git push origin my-feature-branch.
  2. Create a pull request from your branch to the main repository.
  3. Describe your changes and reference any related issues.

Code Style

Please adhere to the Swift Style Guide, and use the provided formatting tools in the project.

Testing

Please add appropriate unit tests for any new features or bug fixes. Run the tests in Xcode to ensure that they pass.

Review Process

Your pull request will be reviewed by the maintainers. Please address any review comments promptly.

Getting Help

If you have any questions or need help with your contribution, please contact the maintainers via the GitHub repository or the project's mailing list.

Thank you for contributing to SSS!