Updated contribution guidelines
This commit is contained in:
parent
7ab3811628
commit
21046089d2
|
@ -58,6 +58,7 @@ When you submit a new sample, please follow these guidelines:
|
|||
|
||||
* You will need to have a `README.md` file for your contribution, which is based on [the provided template](../samples/README-template.md) under the `samples` folder. Please copy this template to your project and update it accordingly. Your `README.md` must be named exactly `README.md` -- with capital letters -- as this is the information we use to make your sample public.
|
||||
* You will need to have a screenshot picture of your sample in action in the `README.md` file ("pics or it didn't happen"). The preview image must be located in the `assets` folder in the root of your sample folder.
|
||||
* The README template contains a specific tracking image at the end of the file with an `img` element pointing to `https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/readme-template`. This is a transparent image which is used to track how many visits each sample receives in GitHub.
|
||||
* Update the image `src` attribute according with the repository name and folder information. For example, if your sample is named `react-todo` in the `samples` folder, you should update the `src` attribute to `https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-todo`
|
||||
* Update the image `src` attribute according with the repository name and folder information.
|
||||
* If you find an existing sample which is similar to yours, please extend the existing one rather than submitting a new similar sample
|
||||
|
|
Loading…
Reference in New Issue