You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

53 lines
2.3 KiB

7 years ago
  1. # Developer Guide
  2. The following document describes the setup and workflow that is recommended for working on the Windows Forms project. It assumes that you have read the [Contributing Guide](../CONTRIBUTING.md).
  3. The [Issue Guide](issue-guide.md) describes our approach to using GitHub issues.
  4. ## Machine Setup
  5. Windows Forms requires the following workloads and components be selected when installing Visual Studio 2022 (17.0.0):
  6. * Required Workloads:
  7. * .NET Desktop Development
  8. * Desktop development with C++
  9. * [Required Individual Components][required-individual-components]:
  10. * Windows 10 SDK
  11. * C++/CLI support
  12. :warning: CMake 3.21.0 or later is required. Install CMake from the [official website][cmake-download] or via [Chocolatey][chocolatey]:
  13. ```
  14. choco install cmake --installargs 'ADD_CMAKE_TO_PATH=System'
  15. ```
  16. * Useful Visual Studio extensions:
  17. * [Editor guidelines](https://marketplace.visualstudio.com/items?itemName=PaulHarrington.EditorGuidelines), see https://github.com/dotnet/winforms/pull/4836 for more information
  18. * [VS Color Output](https://marketplace.visualstudio.com/items?itemName=MikeWard-AnnArbor.VSColorOutput64)
  19. * [Productivity Power Tools](https://marketplace.visualstudio.com/items?itemName=VisualStudioPlatformTeam.ProductivityPowerPack2022)
  20. ## Workflow
  21. We use the following workflow for building as well as testing features and fixes.
  22. You first need to [fork][fork] then [clone][clone] this Windows Forms repository. This is a one-time task.
  23. 1. [Build](building.md) the repository.
  24. 2. [Debug](debugging.md) the change, as needed.
  25. 3. [Test](testing.md) the change, to validate quality.
  26. ## More Information
  27. * [How to write good docs for .NET](https://review.docs.microsoft.com/help/contribute-ref/how-to-write-net-docs?branch=main)
  28. * [.NET Docs and Guidelines][net-runtime-instructions]
  29. * ["help wanted" issues][help wanted]
  30. [comment]: <> (URI Links)
  31. [net-runtime-instructions]: https://github.com/dotnet/runtime/tree/master/docs
  32. [fork]: https://guides.github.com/activities/forking/
  33. [clone]: https://www.git-scm.com/docs/git-clone
  34. [help wanted]: https://github.com/dotnet/winforms/issues?q=is%3Aopen+is%3Aissue+label%3A"help%20wanted"
  35. [chocolatey]: https://chocolatey.org/
  36. [cmake-download]: https://cmake.org/download/
  37. [required-individual-components]: ../WinForms.vsconfig