Skip to content

Latest commit

 

History

History
32 lines (28 loc) · 829 Bytes

CONTRIBUTING.md

File metadata and controls

32 lines (28 loc) · 829 Bytes
Raw

🖥 Contributing

  • Make sure no similar extension already exist in HoneyKit.
  • A pull request should only add one extension at a time.
  • Do not use an existing extension inside another HoneyKit extension.
  • Code should follow Swift Design Guidelines
  • Always declare extensions as public.
  • All extensions should be tested.
  • The file name should be based on the type that extends + added functionality. (Example: UIViewController+ShowAlert.swift)
  • All extensions should be well documented.
// MARK: - Properties

/// <Description>
///
/// # Example
/// ```
/// <Example code>
/// ```

// MARK: - Methods

/// <Description>
///
/// # Example
/// ```
/// <Example code>
/// ```
/// - Parameters:
///   - <Paramer>: <Description>
/// - Returns: <Description>