Skip to content

Commit b3a1c10

Browse files
committed
Merge pull request dotnet#118 from BethMassi/master
Clean up contributing guide to point to samples readme
2 parents bff3838 + 9938392 commit b3a1c10

File tree

2 files changed

+17
-52
lines changed

2 files changed

+17
-52
lines changed

CONTRIBUTING.md

+1-52
Original file line numberDiff line numberDiff line change
@@ -100,55 +100,4 @@ contributing to .NET Core documentation.
100100

101101
## Contributing to Samples
102102

103-
Samples should be:
104-
105-
1. Individual, buildable, and runnable Console apps
106-
2. Fully cross-platform and not dependent on Windows or Visual Studio
107-
3. Tested using Xunit with the Xunit commandline test runner
108-
109-
People should be able to download, build, run, and test the samples on Mac, Linux, or Windows.
110-
111-
To learn about how to build and test new sample projects, see the .NET Class Library Manual (LINK NEEDED).
112-
113-
Sample projects are also broken up by language. Here is an example general structure:
114-
115-
```
116-
/samples
117-
/concept-to-sample
118-
/csharp
119-
global.json
120-
/src
121-
File1.cs
122-
project.json
123-
/test
124-
Test1.cs
125-
project.json
126-
/vb
127-
/fsharp
128-
```
129-
When readying a sample project, please verify that it is runnable and testable.
130-
131-
To do this,
132-
133-
1. Ensure you are running on CoreClr with the latest version of DNX:
134-
135-
```
136-
$ dnvm install latest -r coreclr -u
137-
```
138-
139-
2. Ensure you are targeting DNX Core 5 in your `project.json` file:
140-
141-
```
142-
{
143-
"frameworks:{
144-
"dnxcore50":{}
145-
}
146-
}
147-
```
148-
149-
3. Ensure you can run your sample:
150-
151-
```
152-
$ cd path-to-sample
153-
$ dnx run
154-
```
103+
See the [Samples Readme](https://github.com/dotnet/core-docs/blob/master/samples/README.md).

samples/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,22 @@
22

33
The code samples here are simple, buildable projects which augment the .NET Core Documentation with demonstrative code snippets. These samples are directly embedded into documentation.
44

5+
Sample projects are broken up by language. Here is an example general structure:
6+
7+
```
8+
/samples
9+
/concept-to-sample
10+
/csharp
11+
global.json
12+
/src
13+
File1.cs
14+
project.json
15+
/test
16+
Test1.cs
17+
project.json
18+
/vb
19+
/fsharp
20+
```
521
If you wish to add a code sample:
622

723
1. Your sample **must be part of a buildable project**

0 commit comments

Comments
 (0)