You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+16-12
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,19 @@
1
1
# Contribution Guidance
2
+
2
3
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.
3
4
4
5
## Code of Conduct
6
+
5
7
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
6
8
For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
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.
11
12
12
-
If you have questions about how to use SharePoint Framework or any of the provided samples, please use the following locations.
13
-
14
-
*[SharePoint Developer Space](http://aka.ms/SPPnP-Community) at http://techcommunity.microsoft.com
15
-
*[SharePoint Stack Exchange](http://sharepoint.stackexchange.com/) with 'spfx' tag
13
+
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.
16
14
17
15
## Typos, Issues, Bugs and contributions
16
+
18
17
Whenever you are submitting any changes to the SharePoint repositories, please follow these recommendations.
19
18
20
19
* Always fork repository to your own account for applying modifications
@@ -23,6 +22,7 @@ Whenever you are submitting any changes to the SharePoint repositories, please f
23
22
* If you are submitting typo or documentation fix, you can combine modifications to single PR where suitable
24
23
25
24
## Submitting changes as pull requests
25
+
26
26
Here's a high level process for submitting new samples or updates to existing ones.
27
27
28
28
1. Sign the Contributor License Agreement (see below)
@@ -36,12 +36,13 @@ Here's a high level process for submitting new samples or updates to existing on
36
36
> note. Delete the feature specific branch only AFTER your pull request has been processed.
37
37
38
38
## Sample naming and structure guidelines
39
+
39
40
When you are submitting a new sample, it has to follow up below guidelines
40
41
41
42
- You will need to have a README file for your contribution, which is based on [provided template](../solutions/README-template.md) under the `solutions` folder. Please copy this template and update accordingly. README has to be named as README.md with capital letters.
42
43
- You will need to have a picture of the web part 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.
43
-
- 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-solutions/solutions/readme-template. This is transparent image, which is used to track popularity of individual samples in GitHub.
44
-
- Updated the image src element according with repository name and folder information. If your sample is for example in samples folder and named as ChangeRequests, src element should be updated as https://telemetry.sharepointpnp.com/sp-dev-solutions/solutions/ChangeRequests
44
+
- README template contains specific tracking image as a final entry in the page with img tag by default to https://pnptelemetry.azurewebsites.net/sp-dev-solutions/solutions/readme-template. This is transparent image, which is used to track popularity of individual samples in GitHub.
45
+
- Updated the image src element according with repository name and folder information. If your sample is for example in samples folder and named as ChangeRequests, src element should be updated as https://pnptelemetry.azurewebsites.net/sp-dev-solutions/solutions/ChangeRequests
45
46
- 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
46
47
- When you update existing samples, please update also README accordingly with information on provided changes and with your author details
47
48
- When you are submitting new sample solution, please name the sample solution folder accordingly
@@ -50,39 +51,42 @@ When you are submitting a new sample, it has to follow up below guidelines
50
51
- Do not use period/dot in the folder name of the provided sample
51
52
52
53
## Step-by-step on submitting a pull request to this repository
54
+
53
55
Please see following wiki post from the GitHub repository wiki for exact steps on submitting new pull requests.
54
56
55
57
* How to submit a PR to SharePoint repository? - *Work in progress*
56
58
57
59
## Merging your existing github projects with this repository
60
+
58
61
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-solutions repository:
59
62
60
63
* Fork the sp-dev-solutions repository from GitHub
61
64
* Create a local git repository
65
+
62
66
```
63
67
md sp-dev-solutions
64
68
cd sp-dev-solutions
65
69
git init
66
70
```
71
+
67
72
* Pull your forked copy of sp-dev-solutions into your local repository
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.
84
-
85
-
You can find Microsoft CLA from the following address - https://cla.microsoft.com.
Copy file name to clipboardExpand all lines: README.md
+5-8
Original file line number
Diff line number
Diff line change
@@ -6,12 +6,12 @@ languages:
6
6
- typescript
7
7
extensions:
8
8
contentType: samples
9
-
createdDate: 6/13/2017 12:47:19 PM
9
+
createdDate: 12/13/2022 12:47:19 PM
10
10
---
11
11
12
-
# SharePoint Patterns and Practices Community Solutions
12
+
# Microsoft 365 Platform Community Solutions
13
13
14
-
Welcome to the SharePoint PnP Community Solutions repository. This repository contains samples and templates you can use as foundations and patterns of solutions for your SharePoint sites.
14
+
Welcome to the Microsoft 365 Platform Community Solutions for SharePoint repository. This repository contains samples and templates you can use as foundations and patterns of solutions related on the SharePoint technologies.
15
15
16
16
#### STATUS
17
17
@@ -50,7 +50,7 @@ To build and start using these projects, you'll need to clone and build the proj
50
50
Clone this repository by executing the following command in your console:
Navigate to the cloned repository folder which should be the same as the repository name:
@@ -83,14 +83,11 @@ gulp serve
83
83
84
84
## Contributions
85
85
86
-
These solutions are direct from the feature teams, SharePoint PnP core team (http://aka.ms/SharePointPnP) or shared by the community. This project's contributors include Microsoft and [community contributors](Contributors.md). Work is done as as open source community project. We welcome your input on issues and suggestions for new samples. We also welcome community contributions around new solutions.
86
+
These solutions are direct from the feature teams, Microsoft 365 Platform Community core team (http://aka.ms/m365/community) or shared by the community. This project's contributors include Microsoft and [community contributors](Contributors.md). Work is done as as open source community project. We welcome your input on issues and suggestions for new samples. We also welcome community contributions around new solutions.
87
87
88
88
Please have a look on our [Contribution Guidance](./.github/CONTRIBUTING.md) before submitting your pull requests, so that we can get your contribution processed as fast as possible. Thanks!
89
89
90
-
91
90
> Sharing is caring!
92
91
93
-
94
-
95
92
### Disclaimer
96
93
**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
Copy file name to clipboardExpand all lines: solutions/ChangeRequests/README.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -76,4 +76,4 @@ The My Change Requests web part allows you to submit change requests.
76
76
77
77
The Change Request web parts rely on the CommunityAppsLibrary NPM package which provides common functions used to set up and configure the SharePoint lists the web parts use.
0 commit comments