Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 3.6 KB

CONTRIBUTING.md

File metadata and controls

68 lines (45 loc) · 3.6 KB
Raw

How to contribute

One of the easiest ways to contribute is to participate in discussions on GitHub issues. You can also contribute by submitting pull requests with code changes.

General feedback and discussions?

Start a discussion on the repository issue tracker.

Bugs and feature requests?

❗ IMPORTANT: If you want to report a security-related issue, please see security.md

Before reporting a new issue, try to find an existing issue if one already exists. If it already exists, upvote (👍) it. Also, consider adding a comment with your unique scenarios and requirements related to that issue. Upvotes and clear details on the issue's impact help us prioritize the most important issues to be worked on sooner rather than later. If you can't find one, that's okay, we'd rather get a duplicate report than none.

How to contribute

Getting Started

  1. Enlist (Clone the Repo):
  • git clone https://github.com/david-risney/WebView2Utilities.git
  • If you have a preferred method for cloning GitHub projects, feel free to use that instead.
  1. Build:
  • Open wv2util/wv2util.sln in Visual Studio (VS).
  • Ensure the solution configurations are set to Debug or Release, and the platform is set to Any CPU.
  • Click Build to build the solution.
  1. Debug:
  • Ensure that VS is running as an administrator.
  • Use VS to debug (F5).
  • If wv2util is not running as an administrator, VS will restart it as an administrator. Therefore, it is important to run VS as an administrator so that you will be debugging the correct process.
  1. Test:
  • There are tests in the same solution, but different project (wv2utilTests), that you can run in VS (Ctrl+R).

Submitting Code Changes

  1. Create a new branch from the main branch.
  • git checkout -b my-branch-name
  • Push your code to a user branch
  1. Open a pull request (PR) in GitHub.
  • Open a PR in GitHub and describe the changes you are making.
  • If you are fixing an issue, reference the issue in the PR description.
  1. PR/push pipeline
  • PRs and push in GitHub will build the code and run the tests in GitHub Actions.
  • If the PR fails, you will need to address the issues and push the changes to the same branch.
  1. Feedback and review
  • If the pull request is ready for review, the team member will assign the pull request to a reviewer. A core contributor will review your pull request and provide feedback.
  1. Merge
  • When your pull request has had all feedback addressed, it has been signed off by one or more reviewers with commit access, and all checks are green, we will commit it.

Code of conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.