Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 3.31 KB

CONTRIBUTING.md

File metadata and controls

66 lines (45 loc) · 3.31 KB
Raw

Contributing Guidelines

Code of Conduct

Please read our Code of Conduct. The THScrollViewMinimap maintainers take this Code of Conduct very seriously. Intolerance, disrespect, harassment, and any form of negativity will not be tolerated.

Ways to Contribute

You can contribute to THScrollViewMinimap in a variety of ways:

  • Fixing or reporting bugs 😱
  • Improving documentation ❤️
  • Suggesting new features 😃
  • Increasing unit test coverage 🙏
  • Resolving any open issues 👍

Your contributions are always welcome, no contribution is too small.

Opening a New Issue

  • Please check the README to see if your question is answered there.

  • Search open issues and closed issues to avoid opening a duplicate issue.

  • Avoiding duplicate issues organizes all relevant information for project maintainers and other users.

  • If no issues represent your problem, please open a new issue with a good title and useful description.

  • Information to Provide When Opening an Issue:

    • THScrollViewMinimap version(s)
    • iOS version(s)
    • Devices/Simulators affected
    • Full crash log, if applicable
    • A well written description of the problem you are experiencing
    • Please provide complete steps to reproduce the issue
    • For UI related issues, please provide a screenshot/GIF/video showing the issue
    • Link to a project or demo project that exhibits the issue
    • Search for a list any issues that might be related

The more information you can provide, the easier it will be for us to resolve your issue in a timely manner.

Submitting a Pull Request

  • We strongly encourage you to open an issue discussing any potential new features before an implementation is provided.

    • This ensures the feature is in scope and no ones time is wasted.

  • Please DO NOT submit pull requests to the master branch

    • This branch is always stable and represents a release.

  • Please DO submit your pull request to the branch representing the next release version

  1. Link to any issues the pull request resolves. If none exist, create one.
  2. Write unit tests for new functionality or fix any broken by your changes.
  3. If your changes affect documentation, please update them accordingly.
  4. Avoid pull requests with a large number of commits.
  5. Write clean code and follow the THScrollViewMinimap style guidelines.

You should submit one pull request per feature, the smaller the pull request the better chances it will be merged. Enormous pull requests take a significant time to review and understand their implications on the existing codebase.

Style Guidelines

Writing clean code and upholding project standards is as important as adding new features. To ensure this, THScrollViewMinimap employs a few practices:

  1. We use SwiftLint to enforce style and conventions at compile time.
  2. We adhere to the Swift API Design Guidelines.