Skip to content

Latest commit

 

History

History
72 lines (42 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

72 lines (42 loc) · 2.94 KB

About to create a new Github Issue?

We want to reserve the GitHub Issues page for feature requests and bug reports.

If you have question please ask it on one of these channels:

Please don't cross post. The same people are monitoring the forum and Stack Overflow. Duplicate posts won't get your question answered faster.

When asking a question or filing a bug report, please follow the guidelines on the Calabash iOS wiki home page.

The wiki Home page has several examples of excellent bug reports. You should review one or two of these for tips on how to file a bug report.

If you are pasting code or log output, please use the ``` GitHub code-block formatting.

If you are submitting a pull-request, please read the Contributing information below. Pull-requests without tests or a project to demonstrate the new behavior will probably be rejected.

Please see this post for tips on how to make a good commit message.

Xamarin Studio, UITest, and Test Cloud

Xamarin has a two additional support channels for you. If your question or bug report is UITest or Test Cloud related, your best chance of quick, accurate response will be on one of these channels.

  1. Post your question on the Xamarin Forums.
  2. Send an email to support@xamarin.com

CI Environments (Travis, Jenkins, Bamboo, Team City)

Questions or problems with Calabash in CI environments cannot be handled in the GitHub Issues. Please ask CI related questions on the forums or in Stack Overflow.

Contributing

All pull requests should be based off the develop branch.

The Calabash iOS Toolchain uses git-flow.

See these links for information about git-flow and git best practices.

Git Flow Step-by-Step guide
Git Best Practices
git-flow command line tool

We don't use the git-flow tools, but this is useful anyway.

Start a Feature

Start your work on a feature branch based off develop.

# If you don't already have the develop branch
$ git fetch origin
$ git checkout -t origin/develop

# If you already have the develop branch
$ git checkout develop
$ git pull origin develop
$ git checkout -b feature/my-new-feature

# Publish your branch and make a pull-request on `develop`
$ git push -u origin feature/my-new-feature