Skip to content
This repository has been archived by the owner on Aug 27, 2020. It is now read-only.

Latest commit

 

History

History
76 lines (44 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

76 lines (44 loc) · 2.69 KB

Contributing to Xamarin University Infrastructure

👍🎉 Thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to the Xamarin University public repository on GitHub. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Table Of Contents

What should I know before I get started?

How Can I Contribute?

C# Style Guide

What should I know before I get started?

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to smmark@microsoft.com.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻, and find related reports 🔎.

Before creating bug reports, please check the existing issues to verify that the problem has not been reported already. When you are creating a bug report, please use a clear and descriptive title and include as many details as possible. We recommend the following template:

[Short description of problem here]

** To reproduce **
1. [First Step]
2. [Second Step]
3. [Other Steps...]

**Expected behavior:**

[Describe expected behavior here]

**Actual behavior:**

[Describe observed behavior here]

**Screenshots**

[Add any screen shots to show the issue]

**OS and version:** [Enter OS name and version here]

**Installed NuGet packages:**

[List of other NuGet packages you are usinghere]

**Additional information:**

[Other things we need to know]

Adding Samples and Tests

We welcome samples and unit tests which show off how to use a feature in the library. When submitting a sample, we prefer that:

  • The sample be small and self-contained.
  • Show off a specific class or set of related classes.
  • Be well commented to explain what is happening.

You can add samples to the samples folder.

New Functionality

We also welcome new functionality and classes! Make sure to include some documentation for any new classes or functionality added. It's also helpful to submit unit tests or some sort of sample to show off how to use the new feature/functionality.