Skip to content

Latest commit

 

History

History
126 lines (88 loc) · 5.04 KB

CONTRIBUTING.md

File metadata and controls

126 lines (88 loc) · 5.04 KB
Raw

Contributing

Thanks for your time and interest for contributing to the IVPN iOS app project!
As a contributor, here are the guidelines we would like you to follow:

Contributing Code

  • By contributing to this project you are agreeing to the terms stated in the Contributor License Agreement.
  • By contributing to this project, you share your code under the GPLv3 license, as specified in the License file.
  • Don't forget to add yourself to the Authors file.

Creating an Issue

  • If you want to report a security problem DO NOT CREATE AN ISSUE, please read our Security Policy on how to submit a security vulnerability.
  • When creating a new issue, chose a "Bug report" or "Feature request" template and fill the required information.
  • Please describe the steps necessary to reproduce the issue you are running into.

Pull Requests

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the developers might not want to merge into the project.

Follow these steps when you want to submit a pull request:

  1. Go over installation guides in the README
  2. Follow our Git Workflow
  3. Follow our Commit Message Guidelines
  4. Follow instructions in the PR Template
  5. Update the README file with details of changes if applicable

Git Workflow

This project is using Gitflow Workflow.

Branch naming guidelines

Naming for branches is made with following structure:

<type>/<issue ID>-<short-summary-or-description>

In case when there is no issue:

<type>/<short-summary-or-description>

Where can be epic, feature, task, bugfix, hotfix or release.

Branches

master - The production branch. Clone or fork this repository for the latest copy.
develop - The active development branch. Pull requests should be directed to this branch.
<feature branch> - The feature of fix branch. Pull requests should be made from this branch into develop brach.

Commit Message Guidelines

We have very precise rules over how our git commit messages should be formatted. This leads to readable messages that are easy to follow when looking through the project history.

Commit message format

We follow the Conventional Commits specification. A commit message consists of a header, body and footer. The header has a type, scope and subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and the scope of the header is optional.

Type

Must be one of the following:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing tests
  • build: Changes that affect the build system
  • ci: Changes to our CI configuration files and scripts
  • vendor: Bumping a dependency like libchromiumcontent or node
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

Coding Conventions

This projects is using SwiftLint to enforce code style and conventions. Before submitting any code changes, make sure to run lint task to check for any compile warnings:

$ fastlane lint

IVPN iOS App Beta Program

Users with an active IVPN account can join our iOS app beta program:

  1. Install the iOS TestFlight app
  2. Open https://testflight.apple.com/join/FnmEzHHb on your iOS device
  3. You will be presented with detailed instructions on how to install the IVPN iOS beta app

Any feedback will be very useful to us. You can submit feedback either by opening an issue on GitHub, or send a direct message to [email protected].

IMPORTANT NOTE:
Do not use IVPN prerelease (beta) apps in situations where you need to protect your privacy or security, but only for testing new unreleased features and improvements.