Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (33 loc) · 3.52 KB

CONTRIBUTING.md

File metadata and controls

55 lines (33 loc) · 3.52 KB

Contributing Guidelines

We welcome contributions from the community. If you would like to contribute, please follow the guidelines below.

If this is your first time contributing, learn how to contribute to a project through forking.

Configure your environment

Learn how to configure your environment to develop this project. This assumes you meet the system requirements for Windows app development.

Using Visual Studio

If you already have Visual Studio installed and have developer mode enabled, you may import the .vsconfig installation configuration file.

  1. Open the Visual Studio Installer and close Visual Studio.
  2. On either the Installed tab or the Available tab, select More > Import configuration on the Visual Studio product card.
  3. Locate the .vsconfig file from the project root, and then choose Review details.
  4. Verify that your selections are accurate, and then choose Modify.

Additionally, Visual Studio will automatically detect any missing components in a open solution and will prompt you to install them if not already installed.

Solution Explorer suggests additional components

For more ways to install, learn how to import or export installation configurations.

Building the project

You can build the project with Visual Studio. Before building the project, ensure your environment is configured correctly.

  1. In Solution Explorer, choose or open the solution.
  2. On the menu bar, choose Build > Build Solution, or press Ctrl+Shift+B.

To debug the project, press F5 or choose Debug > Start Debugging.

For more information, learn how to build and clean projects and solutions in Visual Studio.

Helpful resources

Resources to help you contribute to this project and learn more about Windows app development:

Rules

  • Follow the pattern of what you already see in the code.
  • Please follow as Modern C# of a style as you can and reference the .NET Engineering Guidelines as much as you possibly can.
  • Try to package new functionality/components into libraries that have nicely defined interfaces.
  • Package new functionality into classes or refactor existing functionality into a class as you extend the code.
  • When adding new classes/methods/changing existing code, add new unit tests or update the existing tests.

License

By contributing, you agree that your contributions will be licensed under the GNU General Public License v3.0.