Skip to content

Latest commit

 

History

History
49 lines (28 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

49 lines (28 loc) · 1.77 KB

How to Contribute

We'd love to get patches from you!

Getting Started

This is a small guide on how to get started contributing to XCMetrics itself. A more in-depth guide on how to integrate it with your infrastructure is available here.

If you're specifically interested in contributing to the core of the tool, feel free to pick an issue and or mention @spotify/foundation for help.

Building the Project

XCMetrics uses the Swift Package Manager to manage its dependencies and project. After cloning the repo, you can open the project from Xcode by opening the file Package.swift.

Workflow

We follow the GitHub Flow Workflow

  1. Fork the project
  2. Check out the main branch
  3. Create a feature branch
  4. Write code and tests for your change
  5. From your branch, make a pull request against https://github.com/spotify/XCMetrics/main
  6. Work with repo maintainers to get your change reviewed
  7. Wait for your change to be pulled into https://github.com/spotify/XCMetrics/main
  8. Delete your feature branch

Testing

To run all tests, either run swift test from the command line or execute the tests via the project in Xcode.

Style

TODO: mention SwiftLint and SwiftFormat when integrated

Documentation

The docs directory contains all available documentation.

We also welcome improvements to the project documentation or to the existing docs. Please file an issue.

License

By contributing your code, you agree to license your contribution under the terms of the LICENSE]

Code of Conduct

Read our Code of Conduct for the project.