Skip to content

Commit f248e53

Browse files
committed
Create CONTRIBUTING.md
1 parent da144af commit f248e53

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

CONTRIBUTING.md

Lines changed: 43 additions & 0 deletions
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 [[email protected]](mailto:[email protected]) with any additional questions or comments.

0 commit comments

Comments
 (0)