Skip to content

Latest commit

 

History

History
75 lines (54 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

75 lines (54 loc) · 2.29 KB

Contributing to WingedSwift

Thank you for considering contributing to WingedSwift! We welcome contributions from the community to make this project better.

How to Contribute

Reporting Bugs

If you find a bug, please create an issue with the following information:

  • A clear and descriptive title.
  • A detailed description of the bug.
  • Steps to reproduce the bug.
  • Any relevant code snippets or screenshots.
  • Your environment (e.g., OS, Swift version).

Feature Requests

If you have an idea for a new feature or improvement, please create an issue with the following information:

  • A clear and descriptive title.
  • A detailed description of the feature or improvement.
  • The motivation behind the feature or improvement.
  • Any relevant code snippets or examples.

Submitting Changes

If you would like to submit changes, please follow these steps:

  1. Fork the repository: Click the "Fork" button at the top right of the repository page.
  2. Clone your fork: 
    git clone https://github.com/your-username/WingedSwift.git
  3. Create a new branch: 
    git checkout -b feature/your-feature-name
  4. Make your changes: Implement your changes and add tests if applicable.
  5. Commit your changes: 
    git commit -am 'Add some feature'
  6. Push to your branch: 
    git push origin feature/your-feature-name
  7. Open a Pull Request: Go to the original repository on GitHub and create a Pull Request from your forked repository.

Code Style

Please follow the coding standards and style of the project. Here are some guidelines:

  • Use descriptive variable and function names.
  • Write clear and concise comments where necessary.
  • Keep code DRY (Don't Repeat Yourself).

Running Tests

Before submitting your changes, make sure all tests pass. You can run tests using the following command:

swift test

Documentation

If your contribution involves changes to the public API, please update the documentation accordingly.

Code of Conduct

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

Getting Help

If you have any questions, feel free to open an issue or join the discussion in our community forum.

Thank you for contributing to WingedSwift!