Skip to content

pull_request_template.md

Latest commit

 

History

History
84 lines (77 loc) · 2.65 KB

pull_request_template.md

File metadata and controls

84 lines (77 loc) · 2.65 KB

Thank you for submitting your change to the project, we really appreciate your help.

For us to be able to review and merge your changes as quickly as possible, please review our pull request process.

(DELETE THIS PARAGRAPH AFTER READING)

Pull Request Title

Please ensure that you have included a meaningful title describing your change.

For example...

  • Adds 'spo orgassetslibrary remove' command. Closes #1042
  • Extends 'spo site list' command with support for returning deleted sites. Closes #1335
  • Fixes 'spo listitem add' command. Closes #1297

(DELETE THIS SECTION AFTER READING)

Linked Issue

Please ensure that your change is related to an open issue, we will not accept changes without a related issue.

You should link your pull request to an open issue using the Closes keyword, referencing the issue using # and the issue id. This will ensure that the issue is automatically closed when your pull request is merged.

(DELETE THIS SECTION AFTER READING)

Closes #

One PR = One Commit

We prefer to review pull requests that contain a single commit as this makes it easier to keep the history clear for everyone and track what's changed.

If you are new to git, we'll squash your commits for you when merging your changes.

To squash your commits, use the interactive rebase method, git rebase -i HEAD~<commits>, squashing the commits into a single commit and changing your commit message to be the same as your pull request title.

(DELETE THIS SECTION AFTER READING)

New Command = Five Files

If your pull request contains the changes for a new command, it should contain five changed files.

For example, a pull request for adding 'teams tab add' command, would include...

  • src/m365/teams/commands.ts
  • src/m365/teams/commands/tab/teams-tab-add.ts
  • src/m365/teams/commands/tab/teams-tab-add.spec.ts
  • docs/src/config/sidebars.js
  • docs/docs/cmd/teams/tab/tab-add.mdx

(DELETE THIS SECTION AFTER READING)

Main Branch Only

You should only submit your changes to the main branch.

Pull requests submitted to other branches will be rejected.

(DELETE THIS SECTION AFTER READING)

Merge Conflicts

Merge conflicts occur when the branch you want to merge is out of date. To ensure this does not happen, you should ensure that your branch is up-to-date before submitting your pull request by executing the below git commands.

git checkout main

git pull upstream main

git push origin main

git checkout <your-branch>

git rebase main

git push origin <your-branch> -f

(DELETE THIS SECTION AFTER READING)