Skip to content

Latest commit

 

History

History
74 lines (53 loc) · 5.35 KB

pnp-sic-contribution-guidance.md

File metadata and controls

74 lines (53 loc) · 5.35 KB

SharePoint Patterns and Practices

Sharing-Is-Caring Contribution Guidance Opportunities

-- First time PnP Contribution --

Contributing to the OfficeDevPnP for the first time may seem intimidating, but is actually quite simple. In fact the only requirements are a free GitHub account and a web browser.

Personal and hands-on guidance is available to you for completing your very first OfficeDevPnP contribution.

The Sharing-Is-Caring repository provides the opportunity to walk you through, from start to finish, your first OfficeDevPnP pull request and the tutorial contribution will even count as an official contribution, placing your name on the contributor list for that month!

Monthly hands-on tutorial

Each month, a pre-scheduled, live hands-on tutorial session will be available for first time OfficeDevPnP contributions.
NOTE: Additional sessions may be added based on demand

The session will provide the following hands-on experience for each attendee:

  • SharePoint development documentation updates using GitHub
  • Submitting documentation updates such as spelling and grammar corrections with a GitHub pull request
  • Understanding of the OfficeDevPnP pull request process, including providing a useful and accurate pull request description.
  • For each attendee, a personalized documentation update will be prepared, allowing all attending to experience the pull request process, from start to finish.

Session Requirements:

  • Free GitHub account
  • Web Browser

To attend the next Sharing-Is-Caring First Time PnP Contribution training session, please register for the next session using the Sharing-Is-Caring first PnP contribution registration form.

-- PnP Code Sample Contribution --

(SPFx Web Part, SPFx Extension, SPFx Library Component, List Formatting Definition, Etc.)

Contributing a code sample to the OfficeDevPnP can be more complex then a first time documentation contribution, but it is nothing to be afraid of. In addition to the requirements of a first time contribution (GitHub account & a web browser), the only additional requirement is the installation of VSCode.

Monthly hands-on tutorial

Each month, a pre-scheduled, live hands-on session is available for OfficeDevPnP sample code contributions.

The session will provide the following hands-on experience for each attendee:

  • GitHub SPFx samples repository forking into personal GitHub account and cloning to your local development environment
  • Committing SPFx sample to personal GitHub forked repository using Visual Studio Code
  • Submitting the new sample using a GitHub pull request
  • Understanding of the OfficeDevPnP sample code contribution pull request process, including how to provide a useful and accurate pull request description.
  • For each attendee, a personalized SPFx sample will be prepared, allowing all attending to experience the pull request process, from start to finish.

Session Requirements:

  • Free GitHub account
  • Web Browser
  • Visual Studio Code

The schedule and registration options for PnP Code Sample Contribution tutorials will be available soon

-- PnP SPFx Sample Updates Contribution using the Office365 CLI --

Upgrading SPFx Samples with the Office365 CLI "Project Upgrade" Command

If you would like to contribute to the SPFx PnP initiatives, but don't yet have any of your own custom samples, there is still an opportunity to contribute. Existing samples, which have been created and submitted using an older version of SPFx, can be upgraded to the newest version of SPFx using the "Project Upgrade" with the Office365 CLI. The updated sample can then be submitted back into the original sample PnP repository using a GitHub pull request.

A sample upgrade contribution helps by keeping the SPFx samples updated and counts as an official PnP contribution.

Monthly hands-on tutorial

Each month, a pre-scheduled, live hands-on session is available for OfficeDevPnP sample code contributions.

The session will provide the following hands-on experience for each attendee:

  • GitHub SPFx samples repository forking into personal GitHub account and cloning to your local development environment
  • Updating an existing sample using the Office365 CLI
  • Committing updated SPFx sample to personal GitHub forked repository using Visual Studio Code
  • Submitting the updated sample using a GitHub pull request
  • Understanding of the OfficeDevPnP sample code contribution pull request process, including how to provide a useful and accurate pull request description.
  • For each attendee, a personalized SPFx upgrade ready sample will be prepared, allowing all attending to experience the Office365 CLI Project Upgrade command and the pull request process to update the sample, from start to finish.

Session Requirements:

The schedule and registration options for PnP SPFx Sample Updates Contribution using the Office365 CLI tutorials will be available soon