If you'd like to contribute to this repository, please read the following guidelines. Contributors are more than welcome to share your learnings with others from centralized location.
This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
Please do not open GitHub issues for general support questions as the GitHub list should be used for feature requests and bug reports. This way we can more easily track actual issues or bugs from the code and keep the general discussion separate from the actual code.
If you have questions about how to use SharePoint Framework or any of the provided samples, please use the following locations.
- SharePoint Developer Space at http://techcommunity.microsoft.com
- SharePoint Stack Exchange with 'spfx' tag
Whenever you are submitting any changes to the SharePoint repositories, please follow these recommendations.
- Always fork repository to your own account for applying modifications
- Do not combine multiple changes to one pull request, please submit for example any samples and documentation updates using separate PRs
- If you are submitting multiple samples, please create specific PR for each of them
- If you are submitting typo or documentation fix, you can combine modifications to single PR where suitable
Here's a high level process for submitting new samples or updates to existing ones.
- Sign the Contributor License Agreement (see below)
- Fork the main repository to your GitHub account
- Create a new branch for your fork for the contribution based on dev branch
- Include your changes to your branch
- Commit your changes using descriptive commit message - These are used to track changes on the repositories for monthly communications, see May 2017 as an example
- Create a pull request in your own fork and target 'dev' branch
- Fill up the provided PR template with the requested details
note. Delete the feature specific branch only AFTER your pull request has been processed.
When you are submitting a new sample, it has to follow up below guidelines
- You will need to have a README file for your contribution, which is based on provided template under the Samples folder. Please copy this template and update accordingly. README has to be named as README.md with capital letters.
- You will need to have a picture of the extension in practice in the README file ("pics or it didn't happen"). Preview image must be located in /assets/ folder in the root your you solution.
- README template contains specific tracking image as a final entry in the page with img tag by default to https://telemetry.sharepointpnp.com/sp-dev-fx-extensions/samples/readme-template. This is transparent image, which is used to track popularity of individual samples in GitHub.
- Updated the image src element according with repository name and folder information. If your sample is for example in samples folder and named as react-field-map, src element should be updated as https://telemetry.sharepointpnp.com/sp-dev-fx-extensions/samples/react-field-map
- If you find already similar kind of sample from the existing samples, we would appreciate you to rather extend existing one, than submitting a new similar sample
- If you for example use Microsoft Graph with React, please rather add new extension to already existing solution, rather than introducing completely new solution
- When you update existing samples, please update also README accordingly with information on provided changes and with your author details
- When you are submitting new sample solution, please name the sample solution folder accordingly
- Folder should start by identifying JS library used - like "react-", "angular-", "knockout-"
- Folder should also contain extension type identifier after JS library. Options are "-application-", "-command-" and "-field-"
- If you are not using any specific JS library, please use "js-" as the prefix for your sample
- Do NOT use words "sample", "code", "customizer", "extension" or "ext" in the folder or sample name - these are samples for SPFx Extensions repository, so it's obvious what they are customizers or extensions
- If your solution is demonstrating multiple technologies, please use functional terms as the name for the solution folder
- Do not use period/dot in the folder name of the provided sample
Following are valid examples for the naming of your folder for your sample.
react-application-megamenu
knockout-command-duplicate
js-field-map
Please see following wiki post from the GitHub repository wiki for exact steps on submitting new pull requests.
- How to submit a PR to SharePoint repository? - Work in progress
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 Psp-dev-fx-extensions repository:
- Fork the sp-dev-fx-extensions repository from GitHub
- Create a local git repository
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
git remote add origin https://github.com/yourgitaccount/sp-dev-fx-extensions.git
git pull origin dev
- Pull your other project from github into the samples folder of your local copy of sp-dev-fx-extensions
git subtree add --prefix=samples/projectname https://github.com/yourgitaccount/projectname.git master
- Push the changes up to your forked repository
git push origin dev
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 - https://cla.microsoft.com.
Thank you for your contribution.
Sharing is caring.