Skip to content
This repository has been archived by the owner on Apr 29, 2019. It is now read-only.

Latest commit

 

History

History
68 lines (45 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

68 lines (45 loc) · 1.86 KB
Raw

Contributing

First, thanks for taking the time to submit a pull request! These are the few notes and guidelines to keep things coherent.

Overview

  1. Read and abide by the Code of Conduct.
  2. Fork the project and clone.
  3. Check you have all requirements in place.
  4. Create your feature branch.
  5. Install the project dependencies for development.
  6. Test.
  7. If you have more than trivial changes (e.g. fixing typo's), then you must include a description in the CHANGELOG.md.
  8. Push your branch and submit a Pull Request.

We will review the changes as soon as possible.

Requirements

Feature Branch

Please use a descriptive and concise name for your feature branch. Below is a snippet to show how to create a branch with git.

git checkout -b feature/feature-name

Install

After installing Swift (or Xcode) and SwiftLint run the following terminal command from the project folder to build the project.

make build

Test

You can quickly run the test suite. From the project directory, use the following terminal command:

make test

Release

Before releasing, ensure both the version command and the .app-version files have been updated with the new version number.

To create the release tag and the release on GitHub, use the following terminal command:

make release-create

Then to build the tool for release and upload to GitHub, run:

make release-artifacts