Permalink
Fetching contributors…
Cannot retrieve contributors at this time
29 lines (22 sloc) 1.94 KB

Submitting a PR

We appreciate your initiative and would love to integrate your work with the rest of the project! Here is how you can help us do it as quickly as possible.

  • check, that your feature branch is up-to-date. If it's not, there is a risk of merge conflicts or other issues that will complicate merging your changes into the main repository. Refer to these resources for more information on syncing your repo:
    • GitHub Help: Syncing a Fork

    • AC: Keep Your Forked Git Repo Updated with Changes from the Original Upstream Repo

    • Looking for a quick cheat sheet? Look no further:

      # assuming you are in the folder of your locally cloned fork....
      git checkout dev
      
      # assuming you have a remote named `upstream` pointing to the official **office365-cli** repo
      git fetch upstream
      
      # update your local dev branch to be a mirror of what's in the main repo
      git pull --rebase upstream dev
      
      # switch to your branch where you are working, say "issue-xyz"
      git checkout issue-xyz
      
      # update your branch to update its fork point to the current tip of dev & put your changes on top of it
      git rebase dev
  • submit PR to the dev branch of the main repo. PRs submitted to other branches will be declined
  • let us know what's in the PR: is it a new command, bug fix or a minor update in the docs? The clearer the information you provide, the quicker your PR can be verified and merged
  • ideally 1 PR = 1 commit - this makes it easier to keep the log clear for everyone and track what's changed. If you're new to working with git, we'll squash your commits for you when merging your changes into the main repo
  • don't worry about changing the version or adding yourself to the list of contributors in package.json. We'll do that for you when merging your changes.