Skip to content

Submitting a Pull Request (PR)

Submitting Pull Requests

Here's a high level process for submitting new samples or updates to existing ones.

  1. Sign the Contributor License Agreement (see below)
  2. Fork this repository SharePoint/sp-dev-fx-extensions to your GitHub account
  3. Create a new branch off the main branch for your fork for the contribution
  4. Include your changes to your branch
  5. Commit your changes using descriptive commit message * These are used to track changes on the repositories for monthly communications
  6. Create a pull request in your own fork and target dev branch
  7. Fill up the provided PR template with the requested details

Before you submit your pull request consider the following guidelines:

  • Search GitHub for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
  • Make sure you have a link in your local cloned fork to the SharePoint/sp-dev-fx-extensions:

```shell # check if you have a remote pointing to the Microsoft repo: git remote -v

# if you see a pair of remotes (fetch & pull) that point to, you're ok... otherwise you need to add one

# add a new remote named "upstream" and point to the Microsoft repo git remote add upstream ```

  • Make your changes in a new git branch:

shell git checkout -b react-field-slider main

  • Ensure your fork is updated and not behind the upstream sp-dev-fx-extensions repo. Refer to these resources for more information on syncing your repo:
  • GitHub Help: Syncing a Fork
  • Keep Your Forked Git Repo Updated with Changes from the Original Upstream Repo
  • For a quick cheat sheet:


    assuming you are in the folder of your locally cloned fork....

    git checkout main

    assuming you have a remote named upstream pointing official sp-dev-fx-extensions repo

    git fetch upstream

    update your local main to be a mirror of what's in the main repo

    git pull --rebase upstream main

    switch to your branch where you are working, say "react-field-slider"

    git checkout react-field-slider

    update your branch to update it's fork point to the current tip of main & put your changes on top of it

    git rebase main ```

  • Push your branch to GitHub:

shell git push origin react-field-slider

Merging your Existing GitHub Projects with this Repository

If the sample you wish to contribute is stored in your own GitHub repository, you can use the following steps to merge it with the this repository:

  • Fork the sp-dev-fx-extensions repository from GitHub
  • Create a local git repository

    shell md sp-dev-fx-extensions cd sp-dev-fx-extensions git init

  • Pull your forked copy of sp-dev-fx-extensions into your local repository

    shell git remote add origin git pull origin dev

  • Pull your other project from GitHub into the samples folder of your local copy of sp-dev-fx-extensions

    shell git subtree add --prefix=samples/projectname main

  • Push the changes up to your forked repository

    shell git push origin dev

Signing the CLA

Before we can accept your pull requests you will be asked to sign electronically Contributor License Agreement (CLA), which is prerequisite for any contributions to PnP repository. This will be one time process, so for any future contributions you will not be asked to re-sign anything. After the CLA has been signed, our PnP core team members will have a look on your submission for final verification of the submission. Please do not delete your development branch until the submission has been closed.

You can find Microsoft CLA from the following address -

Thank you for your contribution.

Sharing is caring.