Skip to content

Commit 5681738

Browse files
authored
Merge pull request SharePoint#181 from SharePoint/staging
Updates to contribution guidelines
2 parents 341444f + 6048350 commit 5681738

File tree

1 file changed

+35
-7
lines changed

1 file changed

+35
-7
lines changed

.github/CONTRIBUTING.md

Lines changed: 35 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,54 @@ The `docs` folder contains the key developer topics:
1616
```
1717
docs
1818
--spfx
19+
--apis
1920
```
2021
At this time, contributions are accepted for:
2122

2223
* SharePoint Framework Developer Preview
24+
* SharePoint Webhooks
2325

24-
The `spfx` folder is further classified into `basics` and `get-started`:
26+
### SPFx Folder
27+
28+
The `spfx` folder contains documentation for SharePoint Framework. It is further classified into component folders, for example: `webparts`. This folder will expand with new components as they are released.
2529

2630
```
2731
docs
2832
--spfx
29-
----basics
30-
----get-started
33+
---webparts
34+
-----basics
35+
-----get-started
36+
-----developer-guide
3137
```
3238

33-
`get-started` folder contains walkthroughs and tutorials on how to get started building client-side web parts.
39+
#### Component folder
40+
Every component folder contains the following folders:
41+
* basics
42+
* `basics` folder contains concept docs that are helpful in building that particular component, for example: `web parts`.
43+
* get-started
44+
* `get-started` folder contains walkthroughs and tutorials on how to get started building that particular component, for example: `web parts`.
45+
* developer-guide
46+
* `developer-guide` folder contains guides, best practices and reference implementations for that particular component, for example: `web parts`.
47+
*
48+
Any images associated with the docs should be uploaded into the `sp-dev-docs\images` folder.
49+
50+
### SharePoint Webhooks
51+
52+
The `apis\webhooks` folder contains the documentation for SharePoint webhooks. It is further classified into webhook endpoints, for example: `lists`. This folder will expand with new endpoints as they are released.
53+
54+
```
55+
docs
56+
--apis
57+
----webhooks
58+
-----lists
59+
```
60+
61+
`webhooks` folder contains basic documentation around getting started and any other docs that cover webhooks in general.
62+
63+
`webhooks\lists` folder contains API documentation around the list subscription service.
3464

35-
`basics` folder contains client-side web part concept docs that are helpful in building client-side web parts.
65+
Any images associated with the docs should be uploaded into the `sp-dev-docs\images` folder.
3666

37-
Any images associated with the docs should be uploaded into the `spfx\images` folder.
38-
3967
## Forking SharePoint Developer Docs repository
4068

4169
The first step is registering yourself on GitHub. Go to https://github.com/ and click on the "Sign up for GitHub" button. Once you're registered ensure you're logged on with your new account and navigate to the Office 365 Developer Patterns and Practices repository at https://github.com/sharepoint/sp-dev-docs. The right top side of the page contains a button called "Fork":

0 commit comments

Comments
 (0)