Skip to content

Commit dbb3ac2

Browse files
committed
Adding issue templates and contributing info
1 parent 741f6d4 commit dbb3ac2

File tree

3 files changed

+98
-0
lines changed

3 files changed

+98
-0
lines changed
+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Ask a question
3+
about: Ask a question about Graph, adding features to this sample, etc.
4+
title: ''
5+
labels: question, needs triage
6+
assignees: ''
7+
8+
---
9+
10+
Thank you for taking an interest in Microsoft Graph development! Please feel free to ask a question here, but keep in mind the following:
11+
12+
- This is not an official Microsoft support channel, and our ability to respond to questions here is limited. Questions about Graph, or questions about adding a new feature to the sample, will be answered on a best-effort basis.
13+
- Questions should be asked on [Stack Overflow](https://stackoverflow.com/questions/tagged/microsoft-graph).
14+
- Issues with Microsoft Graph itself should be handled through [support](https://developer.microsoft.com/graph/support).

.github/ISSUE_TEMPLATE/bug_report.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug report, needs triage
6+
assignees: ''
7+
8+
---
9+
10+
**Where did you get the code?**
11+
- [ ] Downloaded from GitHub
12+
- [ ] Downloaded from the [Microsoft Graph quick start tool](https://developer.microsoft.com/graph/quick-start)
13+
- [ ] Followed the tutorial from [Microsoft Graph tutorials](https://docs.microsoft.com/graph/tutorials)
14+
15+
**Describe the bug**
16+
A clear and concise description of what the bug is.
17+
18+
**To Reproduce**
19+
Steps to reproduce the behavior:
20+
1. Go to '...'
21+
2. Click on '....'
22+
3. Scroll down to '....'
23+
4. See error
24+
25+
**Expected behavior**
26+
A clear and concise description of what you expected to happen.
27+
28+
**Screenshots**
29+
If applicable, add screenshots to help explain your problem.
30+
31+
**Desktop (please complete the following information):**
32+
- OS: [e.g. iOS]
33+
- Browser [e.g. chrome, safari]
34+
- Version [e.g. 22]
35+
36+
**Dependency versions**
37+
- Authentication library (MSAL, etc.) version:
38+
- Graph library (Graph SDK, REST library, etc.) version:
39+
40+
**Additional context**
41+
Add any other context about the problem here.

CONTRIBUTING.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Contributing to Microsoft Graph training repositories
2+
3+
Thank you for contributing to this project! Before submitting your pull request, be sure to consider the following.
4+
5+
## Overview
6+
7+
The code in this repository serves three purposes:
8+
9+
- The Markdown files in the [tutorial](/tutorial) folder are published as a tutorial on the [Microsoft Graph tutorials](https://docs.microsoft.com/graph/tutorials) page.
10+
- The sample project in the [demo](/demo) folder is the source for a [Microsoft Graph quick start](https://developer.microsoft.com/graph/quick-start).**\***
11+
- The sample project in the demo folder is also downloadable directly from GitHub and should run as-is after some simple configuration.
12+
13+
> **\*** Not all training repositories are available as quick starts (yet).
14+
15+
This is important to keep in mind, because changes in one place *may* require changes in another, to keep things in sync. Whereever possible, the Markdown files refer to the source code files directly (using a custom `:::code` syntax), so that updating code in source will automatically update the code in Markdown.
16+
17+
## Updating code
18+
19+
The `:::code` syntax used in Markdown depends on specific comments in the source code file. These comments look like the following:
20+
21+
```csharp
22+
// <MySnippet>
23+
Console.WriteLine("Hello World!");
24+
// </MySnippet>
25+
```
26+
27+
If you update code between these "marker" comments, the Markdown files will automatically get those changes when published to the Microsoft Graph documentation site. If you update code outside of those comments, it's very likely that you'll need to update the corresponding Markdown.
28+
29+
## Adding features
30+
31+
While the enthusiasm is appreciated, please don't send pull requests to add new features to the sample. Because this repository is primarily a "build your first app" tutorial, the feature set is limited, by design.
32+
33+
## Submitting pull requests
34+
35+
Please submit all pull requests to the `master` branch.
36+
37+
## When do changes get published?
38+
39+
Publishing of updates to the [Microsoft Graph tutorials](https://docs.microsoft.com/graph/tutorials) site is not automatic. Changes must first be promoted to the `live` branch, then a build must be triggered by the site admins. This is typically done on an "as-needed" basis.
40+
41+
## Code of conduct
42+
43+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

0 commit comments

Comments
 (0)