Skip to content

Submitting Bugs & Suggestions

Jump to bottom
Rolf Bjarne Kvinge edited this page Sep 21, 2023 · 5 revisions

The Xamarin.iOS and Xamarin.Mac projects track issues and feature requests using the GitHub issue tracker for the xamarin-macios repository. While using the Xamarin tooling, you may encounter an issue that is not specifically related to the Xamarin.iOS or Xamarin.Mac SDK tracked in this repository. Take a quick look at our guide on where to file issues to make sure this is the correct place. When in doubt, use your best judgment on where to file an issue and we’ll help move it if required.

Before Submitting an Issue

First, please do a search in open issues to see if the issue or feature request has already been filed. Use this query to search for the most popular feature requests.

If you find your issue already exists, make relevant comments and add your reaction. Use a reaction in place of a "+1" comment.

👍 - upvote

👎 - downvote

If your issue is a question then please ask the question on Stack Overflow using the tag xamarin.ios or on the Xamarin Forums (Xamarin.iOS | Xamarin.Mac).

If you cannot find an existing issue that describes your bug or feature, submit an issue using the guidelines below.

Writing Good Bug Reports and Feature Requests

File a single issue per problem and feature request.

  • Do not enumerate multiple bugs or feature requests in the same issue.
  • Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes.

The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix.

Please include the following with each issue.

  • Environment and IDE Versions

  • Reproducible steps (1... 2... 3...) and what you expected versus what you actually experienced

  • Images, animations, or a link to a video. Note that images and animations illustrate repro-steps but do not replace them.

  • A minimal, complete, and verifiable example that demonstrates the issue or a link to a code repository we can easily pull down onto our machine to recreate the issue.

    Note: Because we need to copy and paste the code snippet, including a code snippet as a media file (i.e. .gif) is not sufficient.

  • Diagnostic Build Output

  • Application Output

  • Crash Logs

  • Device Logs

  • If building remotely from Windows, zip up and attach the ~/Library/Logs/Xamarin.Messaging* directories on the Mac: :

    zip -9r Xamarin.Messaging.logs.zip ~/Library/Logs/Xamarin.Messaging*

Please remember to do the following:

Simplify your code around the issue so we can better isolate the problem. Don't feel bad if we can't reproduce the issue and ask for more information!

Contributing Fixes

If you are interested in fixing issues and contributing directly to the code base, please visit the How to Contribute page.

Thank You!

We know it can be frustrating to take the time to submit issues or find a feature that is missing. We appreciate your contributions and helping make Xamarin.iOS and Xamarin.Mac better!

Contributing

Bindings

Tips & tricks

Clone this wiki locally