diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000000..4399f488a2e --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,8 @@ +# Contributing + +See [Contributing Guide](../Documentation/contributing-guide.md) for information about: + +* Which kind of PRs we accept/reject for .NET Core 3.0 release +* Coding style +* PR style preferences (squashing vs. merging, etc.) +* Developer guide for building and testing locally diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000000..452d46444e7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,19 @@ +--- +name: Bug report +about: Create a report to help us improve +--- + +* .NET Core Version: (e.g. 3.0 Preview1, or daily build number, use `dotnet --info`) +* Windows version: (`winver`) +* Does the bug reproduce also in WPF for .NET Framework 4.8?: Yes/No + + + + **Problem description:** + + **Actual behavior:** + + **Expected behavior:** + + **Minimal repro:** + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000000..e3deb9d6578 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,6 @@ +--- +name: Feature / API request +about: Suggest an idea for this project +--- + + diff --git a/Documentation/contributing-guide.md b/Documentation/contributing-guide.md new file mode 100644 index 00000000000..ec3b847f2dc --- /dev/null +++ b/Documentation/contributing-guide.md @@ -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]), +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. + +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). diff --git a/README.md b/README.md index 4661845911d..c3a2c3f3b30 100644 --- a/README.md +++ b/README.md @@ -67,9 +67,12 @@ For general .NET Core 3 issues (not specific to WPF), use the [.NET Core repo](h ### Contributing Guide -**TODO** +Read our detailed [contributing guide](Documentation/contributing-guide.md) which covers: -For more details, take a look at the [.NET Core Contribution Guidelines](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/contributing.md). +* Which kind of PRs we accept/reject for .NET Core 3.0 release +* Coding style +* PR style preferences (squashing vs. merging, etc.) +* Developer guide for building and testing locally ### Community