honeymoose
/
sp-dev-fx-webparts
mirror of https://github.com/pnp/sp-dev-fx-webparts.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated contribution guidance with readme details.

This commit is contained in:
Vesa Juvonen 2016-09-14 14:53:16 +03:00
parent 44af9fef3c
commit 2492b20dad
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.github/CONTRIBUTING.md vendored
View File

@ -40,6 +40,8 @@ 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](../samples/README-template.md) 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 web part in practice in the README file. 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-webparts/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-todo, src element should be updated as https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-todo
- 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 Office Graph with React, please rather add new web part 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
@ -47,6 +49,7 @@ When you are submitting a new sample, it has to follow up below guidelines
- Folder should start by identifying JS library used - like react- or angular-
- Do not use words "sample", "webpart" or "wb" in the folder or sample name - these are samples for client-side web parts repository
- 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
## 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.