Skip to content

Commit

Permalink
Add a GitHub issue template (microsoft#1678)
Browse files Browse the repository at this point in the history
* Add a GitHub issue template

* Add some more questions to issue template

* Updates to CONTRIBUTING.md

- Don't tell people to use the Schema label since non-contributors can't use labels
- Eliminate some early preview wording
- Fix some links

* Direct questions to StackOverflow
  • Loading branch information
Andrew Bares authored Jul 3, 2018
1 parent 9c5743d commit c331281
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 5 deletions.
14 changes: 9 additions & 5 deletions CONTRIBUTING.md → .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,23 @@
## 2. Do you have a question?

Please use the issue tracker for bugs and suggestions.
If you have a *question*, please use [Stack Overflow](http://stackoverflow.com/questions/tagged/adaptive-cards)

If you have a *question*, please use [Stack Overflow](https://stackoverflow.com/questions/tagged/adaptive-cards)

## 3. Did you find a bug?

I'm not surprised, we're still in early preview so there are plenty of them right now :)
I'm not surprised, we're still in the early stages, 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](http://adaptivecards.io/documentation/#about-overview) to make sure the suggestion is aligned with the project goals.
Please take a look at our [Core Design Principles](https://docs.microsoft.com/en-us/adaptive-cards/#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
Expand All @@ -32,13 +34,15 @@ In general, things we find useful when reviewing suggestions are:

## 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.
Our local dev team is in active development, but we are still accepting external 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](http://adaptivecards.io/documentation/#about-overview).
Please open an issue with the `Schema` label to get a discussion started.

Please open an issue with your schema proposal to get a discussion started.

## Legal

Expand Down
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Platform

What platform is your issue or question related to? (Delete other platforms).

* .NET HTML
* .NET WPF
* Android
* iOS
* JavaScript
* UWP

# Author or host

Are you an author (like sending something to Outlook), or a host that is rendering your own cards?

If you're an author, who are you sending cards to?

# Version of SDK

What version are you using? Ex: NuGet 1.0.2, or latest master, etc...

# Issue

Explain your issue. If you just have a question, please post [on StackOverflow instead](https://stackoverflow.com/questions/tagged/adaptive-cards).

0 comments on commit c331281

Please sign in to comment.