@@ -19,17 +19,15 @@ on how to become a
19
19
and
20
20
[ ** Maintainer** ] ( https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer ) .
21
21
22
- ## Find a Buddy and get Started Quickly
22
+ ## Find a Buddy and Get Started Quickly
23
23
24
24
If you are looking for someone to help you find a starting point and be a
25
25
resource for your first contribution, join our Gitter and find a buddy!
26
26
27
27
1 . Join [ Gitter.im] ( https://gitter.im ) and join our [ chat
28
28
room] ( https://gitter.im/open-telemetry/opentelemetry-dotnet ) .
29
29
2 . Post in the room with an introduction to yourself, what area you are
30
- interested in (check issues marked with [ good first
31
- issue] ( https://github.com/open-telemetry/opentelemetry-dotnet/labels/good%20first%20issue )
32
- or [ help
30
+ interested in (check issues marked with [ help
33
31
wanted] ( https://github.com/open-telemetry/opentelemetry-dotnet/labels/help%20wanted ) ),
34
32
and say you are looking for a buddy. We will match you with someone who has
35
33
experience in that area.
@@ -39,70 +37,27 @@ contributing to OpenTelemetry: providing context, reviewing PRs, and helping
39
37
those get merged. Buddies will not be available 24/7, but is committed to
40
38
responding during their normal contribution hours.
41
39
42
- ## Development
43
-
44
- ### Prerequisites
40
+ ## Development Environment
45
41
46
42
You can contribute to this project from a Windows, macOS or Linux machine.
47
- Requirements can very slightly:
48
43
49
- In all platforms, the requirements are:
44
+ On all platforms, the minimum requirements are:
50
45
51
- * Git client and command line tools. You may use Visual Studio to clone the
52
- repo, but we use [ SourceLink] ( https://github.com/dotnet/sourcelink ) to build
53
- and it needs git.
46
+ * Git client and command line tools.
54
47
* .NET Core 3.1+
55
48
56
- #### Windows
57
-
58
- * Visual Studio 2017+, VS Code or JetBrains Rider
59
- * .NET Framework 4.6+
60
-
61
- #### MacOS or Linux
49
+ ### Linux or MacOS
62
50
63
- * Visual Studio for Mac, VS Code or JetBrains Rider
51
+ * Visual Studio for Mac or Visual Studio Code
64
52
65
53
Mono might be required by your IDE but is not required by this project. This is
66
54
because unit tests targeting .NET Framework (i.e: ` net46 ` ) are disabled outside
67
55
of Windows.
68
56
69
- ### Build
70
-
71
- Open ` OpenTelemetry.sln ` in your IDE of choice and follow normal development
72
- process.
73
-
74
- To build from the command line you need ` dotnet ` version ` 3.1+ ` .
75
-
76
- ``` sh
77
- dotnet build OpenTelemetry.sln
78
- ```
79
-
80
- ### Test
81
-
82
- You can use any of the IDEs mentioned above to test your contribution. Open
83
- root folder or ` OpenTelemetry.sln ` in your editor and follow normal development
84
- process.
57
+ ### Windows
85
58
86
- To test from command line you need ` dotnet ` version ` 3.1+ ` .
87
-
88
- ``` sh
89
- dotnet test OpenTelemetry.sln
90
- ```
91
-
92
- ### Code Coverage
93
-
94
- On Linux and macOS run ` dotnet test ` from a terminal window and you will see
95
- the following output:
96
-
97
- ![ image] ( https://user-images.githubusercontent.com/20248180/59361025-1e1e7980-8d29-11e9-8449-548caf0d7823.png )
98
-
99
- Or, after running the tests, open the file ` TestResults\Results\index.htm ` in a
100
- browser.
101
-
102
- On Windows use the ` Analyze Code Coverage for All Tests ` on Visual Studio
103
- ` Test ` menu.
104
-
105
- ![ image] ( docs/vs-code-coverage.png )
59
+ * Visual Studio 2017+ or Visual Studio Code
60
+ * .NET Framework 4.6+
106
61
107
62
## Pull Requests
108
63
@@ -142,8 +97,8 @@ Open a pull request against the main `opentelemetry-dotnet` repo.
142
97
143
98
### How to Receive Comments
144
99
145
- * If the PR is not ready for review, please put ` [WIP] ` in the title, tag it as
146
- ` work-in-progress ` , or mark it as
100
+ * If the PR is not ready for review, please put ` [WIP] ` in the title or mark it
101
+ as
147
102
[ ` draft ` ] ( https://github.blog/2019-02-14-introducing-draft-pull-requests/ ) .
148
103
* Make sure CLA is signed and CI is clear.
149
104
0 commit comments