-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Contributing guide #33
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
f53f961
Create CONTRIBUTING.md
karelz 55b46ff
Create bug_report.md
karelz 17ae153
Create feature_request.md
karelz d9e7c98
Create CONTRIBUTING.md
karelz dda3f0e
Create bug_report.md
karelz ad7a11c
Create feature_request.md
karelz 0796531
Merge branch 'contributing-guide' of https://github.com/karelz/wpf in…
karelz 6295d6b
Create contributing-guide.md
karelz bf219db
Update README.md
karelz 96fba45
Update bug_report.md
karelz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # Contributing Guide | ||
|
|
||
| Primary focus of .NET Core 3.0 release is to achieve parity with WPF for .NET Framework. | ||
| Since we're currently still porting parts of WPF codebase (incl. tests) to GitHub (see progress at [../README.md#port-status]), | ||
karelz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| we're not ready to handle non-trivial or larger contributions beyond parity fixes yet. | ||
|
|
||
| We plan to accept these kind of contributions during 3.0 release: | ||
|
|
||
| * Low-risk changes, which are easy to review (e.g. typos, comment changes, documentation improvements, etc.). | ||
| * Test fixes, test improvements and new tests increasing code coverage. | ||
| * Infrastructure fixes and improvements, which are aligned with achieving our goal to ship high quality .NET Core 3.0 release. | ||
| * Bug fixes for differences between WinForms for .NET Core and .NET Framework. | ||
karelz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| If you have a **larger change** falling into any of these categories, we recommend to **check with our team members** prior to creating a PR. | ||
| We recommend to first create a [new issue](https://github.com/dotnet/wpf/issues), where you can describe your intent and help us understand the change you plan to contribute. | ||
|
|
||
| **WARNING:** Expect that we may reject or postpone PRs which do not align with our primary focus (parity with WPF for .NET Framework), | ||
| or which could introduce unnecessary risk (e.g. in code which is historically sensitive, or is not well covered by tests). | ||
| Such PRs may be closed and reconsidered later after we ship .NET Core 3.0. | ||
|
|
||
|
|
||
|
|
||
| ## Developer Guide | ||
|
|
||
| Before you start, please review [WPF contributing doc](TODO) and **[.NET Core contributing doc](https://github.com/dotnet/corefx/blob/master/Documentation/project-docs/contributing.md)** for coding style and PR gotchas. | ||
|
|
||
| * Per-machine setup: [Machine setup](#machine-setup) and [Fork and clone repo](https://github.com/dotnet/corefx/wiki/Checking-out-the-code-repository) | ||
| * [Build and run tests](#build-and-run-tests) | ||
| * [git commands and workflow](https://github.com/dotnet/corefx/wiki/git-reference) - for newbies on GitHub | ||
| * Pick issue: [up-for-grabs](https://github.com/dotnet/wpf/issues?q=is%3Aopen+is%3Aissue+label%3Aup-for-grabs) or [easy](https://github.com/dotnet/wpf/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+label%3Aeasy) | ||
| * [Coding guidelines](https://github.com/dotnet/corefx/tree/master/Documentation#coding-guidelines) | ||
|
|
||
| ### Machine Setup | ||
|
|
||
| TODO | ||
|
|
||
| ### Build and run tests | ||
|
|
||
| #### To build | ||
|
|
||
| In the root of your repo, run `build.cmd` (or `build.cmd -verbose` for logs). | ||
|
|
||
| #### To run tests | ||
|
|
||
| In the root of your repo, run `test.cmd` or open the solution file `src\Microsoft.DotNet.Wpf\test\DRT\DrtXaml.sln` ("DRT" is an internal name used for unit tests). | ||
| * Note that this will test the version of `System.Xaml.dll` currently installed in your shared framework; if you rebuild `System.Xaml.dll` and want to test your changes, you will need to replace the current DLL with your own (be sure to make a backup first). | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.