Skip to content

Latest commit

 

History

History
98 lines (67 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

98 lines (67 loc) · 2.64 KB
Raw

Contributing

To avoid duplicates, please search existing issues before reporting a new one.

Github Issues is intended for reporting bugs and feature suggestions. If you have a question or need support, please use Stack Overflow or join the conversation on Gitter.

How to Contribute

The Calabash iOS Toolchain uses git-flow.

  • All pull requests should be based off the develop branch.
  • Contributors should never change the version of the product.
  • Contributors should never commit code signing changes.

Best Practices

Etiquette and Code of Conduct

All contributors must adhere to the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Legal

Users who wish to contribute will be prompted to sign a Microsoft Contributor License Agreement (CLA). A copy of the CLA can be found at https://cla.microsoft.com/cladoc/microsoft-contribution-license-agreement.pdf.

Please consult the LICENSE file in this project for copyright and license details.

Testing

# Objective-C Unit tests.
$ make xctests

# Building libraries.
$ make all

# Cucumber
$ make app-cal
$ cd cucumber
$ be cucumber

# Integration tests.
$ scripts/test/run

Releasing

After the release branch is created:

  • No more features can be added.
  • All in-progress features and un-merged pull-requests must wait for the next release.
  • You can, and should, make changes to the documentation.

The release pull request must be made against the master branch.

$ git co -b release/0.21.7

1. Update the CHANGELOG.md.
2. Bump the version in calabash/Classes/FranklyServer/Routes/LPVersionRoute.h
3. **IMPORTANT** Bump the version in the README.md badge.
4. Have a look at the README.md to see if it can be updated.

$ git push -u origin release/0.21.7

**IMPORTANT**

1. Make a pull request on GitHub on the master branch.
2. Wait for CI to finish.
3. Merge pull request.

$ git co master
$ git pull
$ bin/git-tag.sh

$ git co develop
$ git merge --no-ff release/0.21.7
$ git push

$ git branch -d release/0.21.7

Announce the release on the public channels.