Skip to content

Latest commit

 

History

History
207 lines (148 loc) · 6.21 KB

CONTRIBUTING.md

File metadata and controls

207 lines (148 loc) · 6.21 KB
Raw

Contributing Guidelines

This document contains information and guidelines about contributing to this project. Please read it before you start participating.

Topics

Asking Questions

We don't use GitHub as a support forum. For any usage questions that are not specific to the project itself, please ask on Stack Overflow instead with the tag Steps. By doing so, you'll be more likely to quickly solve your problem, and you'll allow anyone else with the same question to find the answer. This also allows us to focus on improving the project for others.

Ways to Contribute

You can contribute to the project in a variety of ways:

  • Improve documentation 🙏
  • Add more extensions 👍
  • Add missing unit tests 😅
  • Fixing or reporting bugs 😱

If you're new to Open Source or Swift the Steps community is a great place to get involved.

Your contribution is always welcomed, no contribution is too small.

Adding new code

Please refer to the following rules before submitting a pull request with your new extensions:

  • Make sure no similar extension already exist in Steps.
  • Add your contributions to master branch:
    • by doing this we can merge new pull-requests into master branch as soon as they are accepted, and add them to the next releases once they are fully tested.
  • Mention the original source of extension source (if possible) as a comment inside extension:
public extension SomeType {

   public name: SomeType {
       // https://stackoverflow.com/somepage
       // .. code
   }

}
  • All methods should be well documented. see Adding documentation
  • All methods should be tested. See Adding Tests to know more.
  • Classes and tests are ordered inside files in the following order:
// MARK: - enums
public enum {
    // ...
}

// MARK: - Properties
public extension SomeType {}

// MARK: - Methods
public extension SomeType {}

// MARK: - Initializers
public extension SomeType {}

Adding Tests

Please follow these guidelines before submitting a pull request with new tests:

  • Every extended Steps type should have one specific subclass of XCTestCase.
  • There should be a one to one relationship between methods/properties and their backing tests.
  • The subclass should be marked as final.
  • All extensions files and test files have a one to one relationship.
    • (example: all tests for "StringExtensions.swift" are found in the "StringExtensionsTests.swift" file)
  • Steps source files should not be added to the test target directly, but you should rather import Steps into the test target by using: @testable import Steps
  • Tests are ordered inside files in the same order as classes.

Adding documentation

Use the following template to add documentation for extensions

Replace placeholders inside <>

Remove any extra lines, eg. if method does not return any value, delete the - Returns: line

Documentation template for units with single parameter

/// Steps: <Description>.
///
///    <Example Code>
///
/// - Parameter <Paramenter>: <Description>.
/// - Throws: <Error>
/// - Returns: <Description>

Documentation template for units with multiple parameters

/// Steps: <Description>.
///
///    <Example Code>
///
/// - Parameters:
///   - <Paramenter>: <Description>.
///   - <Paramenter>: <Description>.
/// - Throws: <Error>
/// - Returns: <Description>

Documentation template for enums

/// Steps: <Description>.
///
/// - <Case1>: <Description>
/// - <Case2>: <Description>
/// - <Case3>: <Description>
/// - <Case4>: <Description>

Documentation Examples

/// Steps: Sum of all elements in array.
///
///    [1, 2, 3, 4, 5].sum() -> 15
///
/// - Returns: Sum of the array's elements.
func sum() -> Element {
    // ...
}

/// Steps: Date by changing value of calendar component.
///
/// - Parameters:
///   - component: component type.
///   - value: new value of component to change.
/// - Returns: original date after changing given component to given value.
func changing(_ component: Calendar.Component, value: Int) -> Date? {
    // ...
}

Power Tip

In Xcode select a method and press command + alt + / to create a documentation template!

Adding changelog entries

The Changelog is a file which contains a curated, chronologically ordered list of notable changes for each version of a project. Please make sure to add a changelog entry describing your contribution to it every time there is a notable change.

The Changelog Guidelines contains instructions for maintaining (or adding new entries) to the Changelog.

Reporting Issues

A great way to contribute to the project is to send a detailed issue when you encounter a problem. We always appreciate a well-written, thorough bug report.

Check that the project issues page doesn't already include that problem or suggestion before submitting an issue. If you find a match, add a quick "+1" or "I have this problem too". Doing this helps prioritize the most common problems and requests.

When reporting issues, please include the following:

  • What did you do?
  • What did you expect to happen?
  • What happened instead?
  • Steps version
  • Xcode version
  • macOS version running Xcode
  • Swift version
  • Platform(s) running Steps
  • Demo Project (if available)

This information will help us review and fix your issue faster.

No Brown M&M's

If you made it all the way to the end, bravo dear user, we love you. You can include the 🚀 emoji in the top of your ticket to signal to us that you did in fact read this file and are trying to conform to it as best as possible: :rocket:.