Skip to content

Forking and Pull Requests

hgupta9 edited this page Dec 2, 2015 · 1 revision

Simple Guide to Forking and Creating a Pull Request (PR) for the CefSharp project.

Style and Code Guidelines

Please read over https://github.com/cefsharp/CefSharp/blob/master/CONTRIBUTING.md (in particular from the Pull Requests/feature branches section and on) to get a sense of coding style, biggest one to note is spaces instead of tabs also for C++ which is not the default Visual Studio setting when starting out.

Basic Forking and PR Creation Steps

  • Fork CefSharp (view the https://github.com/cefsharp/CefSharp repository on GitHub, there is a button top right "Fork")
  • Clone a local copy of your fork using a Git client (URL will look something like https://github.com/username/CefSharp.git) or if you have GitHub Windows client, then just click the "Clone in Desktop" button on your CefSharp fork
  • Commit changes to your local copy
  • When you're happy, push your local changes to your fork
  • Visit your GitHub webpage (https://github.com/username/CefSharp), it will prompt you to create a pull request containing the changes you just made.
  • Review the PR before submitting, make sure the code looks consistent and no unnecessary changes were added.

Reference Articles

Git Clients

The GitHub windows client is probably the simplest interface, once your more comfortable there are many other Git client options available. The GitHub For Windows website has reasonable help, and it tightly integrates with GitHub of course.

Contributions to this guide are welcome! Please help fill in all the blanks.