Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

64 lines (40 loc) · 2.93 KB
Raw

Instructions for Logging Issues

1. Search for Duplicates

Search the existing issues before logging a new one.

2. Do you have a question?

Please use the issue tracker for bugs and suggestions. If you have a question, please use Stack Overflow

3. Did you find a bug?

I'm not surprised, we're still in early preview so there are plenty of them right now :)

When logging a bug, please be sure to include the following:

  • The platform you were using
  • If at all possible, an isolated way to reproduce the behavior
  • The behavior you expect to see, and the actual behavior

4. Do you have a suggestion?

We also accept suggestions in the issue tracker.

Please take a look at our Core Design Principles to make sure the suggestion is aligned with the project goals.

In general, things we find useful when reviewing suggestions are:

  • A description of the problem you're trying to solve
  • An overview of the suggested solution
  • Examples of how the suggestion would work in various places

Instructions for Contributing Code

Contributing bug fixes

Adaptive Cards are current in early preview so there's a lot of churn in the code. We're still accepting contributions in the form of bug fixes. A bug must have an issue tracking it in the issue tracker that has been approved by the Adaptive Cards team. Your pull request should include a link to the bug that you are fixing. If you've submitted a PR for a bug, please post a comment in the bug to avoid duplication of effort.

Contributing features

We're happy to discuss schema proposals as long as they align with our Core Design Principles. Please open an issue with the Schema label to get a discussion started.

Legal

You will need to complete a Contributor License Agreement (CLA). Briefly, this agreement testifies that you are granting us permission to use the submitted change according to the terms of the project's license, and that the work being submitted is under appropriate copyright.

You will be asked to sign the Microsoft Contributor License Agreement (CLA) when you submit a pull request, if there is not already a CLA on file for your GitHub account. Once we have received the signed CLA, we'll review the request.

You can review details of the agreement at https://cla.opensource.microsoft.com.

Housekeeping

Your pull request should:

  • Include a description of what your change intends to do
  • Be a child commit of a reasonably recent commit in the master branch
    • Requests need not be a single commit, but should be a linear sequence of commits (i.e. no merge commits in your PR)
  • Have clear commit messages
    • e.g. "Refactor feature", "Fix issue", "Add tests for issue"

Running the Tests

Coming soon