Updated readme and contributing guidance - polishing
This commit is contained in:
Vesa Juvonen
parent
0b2a284c09
commit
44bcd98004
|
|
@ -18,7 +18,7 @@ If you have questions about how to use SharePoint Framework or any of the provid
|
|||
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 seperate PRs
|
||||
* 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
|
||||
|
||||
|
|
@ -55,21 +55,32 @@ When you are submitting a new sample, it has to follow up below guidelines
|
|||
## Step-by-step on submitting a pull request to this repository
|
||||
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? - Step-by-step with commands and pictures coming soon
|
||||
## Meging your existing github projects with this repository
|
||||
If the sample you wish to contrubute is tored in your own Github repository, you can use the following steps to merge it with the Psp-dev-fx-webparts repository:
|
||||
- Fork the sp-dev-fx-webparts repository om hithub
|
||||
- create a local git rpository
|
||||
md sp-dev-fx-webparts
|
||||
cd sp-dev-fx-webparts
|
||||
git init
|
||||
- pull your forked copy of sp-dev-fx-webparts into your local repository
|
||||
git remote add origin https://github.com/yourgitaccount/sp-dev-fx-webparts.git
|
||||
git pull origin dev
|
||||
- pull your other project from github into the samples folder of your local copy of sp-dev-fx-webparts
|
||||
git subtree add --prefix=samples/projectname https://github.com/yourgitaccount/projectname.git master
|
||||
- push the changes up to your forked repository
|
||||
git push orgin dev
|
||||
* How to submit a PR to SharePoint repository? - *Work in progress*
|
||||
|
||||
## 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 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
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
|
|
|||
12
README.md
12
README.md
|
|
@ -1,29 +1,27 @@
|
|||
# SharePoint Framework client-side web part samples & tutorial materials
|
||||
|
||||
This repo contains the samples that demonstrate different usage patterns for the SharePoint Framework client-side web parts.
|
||||
This repository contains the samples that demonstrate different usage patterns for the SharePoint Framework client-side web parts.
|
||||
|
||||
> Note: The SharePoint Framework is currently in preview and is subject to change. SharePoint Framework client-side web parts are not currently supported for use in production enviornments.
|
||||
|
||||
SharePoint client-side web parts are controls that appear inside a SharePoint page but run locally in the browser. They're the bulding blocks of pages that appear on a SharePoint site. You can build client-side web parts using modern script development tools and the SharePoint workbench (a development test surface), and you can deploy your client-side web parts to classic web part pages in Office 365 Developer tenants. In addition to plain JavaScript projects, you can build web parts alongside common scripting frameworks, such as AngularJS and React. For example, you can use React along with components from Office UI Fabric React to quickly create experiences based on the same components used in Office 365
|
||||
SharePoint client-side web parts are controls that appear inside a SharePoint page but run locally in the browser. They're the building blocks of pages that appear on a SharePoint site. You can build client-side web parts using modern script development tools and the SharePoint workbench (a development test surface), and you can deploy your client-side web parts to classic web part pages in Office 365 Developer tenants. In addition to plain JavaScript projects, you can build web parts alongside common scripting frameworks, such as AngularJS and React. For example, you can use React along with components from Office UI Fabric React to quickly create experiences based on the same components used in Office 365
|
||||
|
||||
# Additional resources
|
||||
|
||||
* [Overview of the SharePoint Framework](http://dev.office.com/sharepoint/docs/spfx/sharepoint-framework-overview)
|
||||
* [SharePoint Framework development tools and libraries](http://dev.office.com/sharepoint/docs/spfx/tools-and-libraries)
|
||||
* [SharePoint Framework Reference](https://sharepoint.github.io/)
|
||||
* [SharePoint Framework Reference](http://aka.ms/spfx-reference)
|
||||
* [Visual Studio Extension for SharePoint Framework projects](https://github.com/SharePoint/sp-dev-fx-vs-extension)
|
||||
|
||||
# Using the samples
|
||||
|
||||
To build and start using these projects, you'll need to clone and build the projects.
|
||||
|
||||
Clone this repo by executing the following command in your console:
|
||||
Clone this repository by executing the following command in your console:
|
||||
|
||||
```
|
||||
git clone https://github.com/SharePoint/sp-dev-fx-webparts.git
|
||||
```
|
||||
|
||||
Navigate to the cloned repo folder which should be the same as the repo name:
|
||||
Navigate to the cloned repository folder which should be the same as the repository name:
|
||||
|
||||
```
|
||||
cd sp-dev-fx-webparts
|
||||
|
|
|
|||
Loading…
Reference in New Issue