Skip to content

Commit 6048350

Browse files
authored
Update CONTRIBUTING.md
expanded spfx and webhooks to a more generic folder structure.
1 parent 6733516 commit 6048350

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

.github/CONTRIBUTING.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,24 +25,31 @@ At this time, contributions are accepted for:
2525

2626
### SPFx Folder
2727

28-
The `spfx` folder is further classified into `basics` and `get-started`:
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.
2929

3030
```
3131
docs
3232
--spfx
33-
----basics
34-
----get-started
35-
```
36-
37-
`get-started` folder contains walkthroughs and tutorials on how to get started building client-side web parts.
38-
39-
`basics` folder contains client-side web part concept docs that are helpful in building client-side web parts.
40-
33+
---webparts
34+
-----basics
35+
-----get-started
36+
-----developer-guide
37+
```
38+
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+
*
4148
Any images associated with the docs should be uploaded into the `sp-dev-docs\images` folder.
4249

4350
### SharePoint Webhooks
4451

45-
The `apis\webhooks` folder contains the documentation for SharePoint webhooks. It is further classified into webhook endpoints, for example: lists.
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.
4653

4754
```
4855
docs

0 commit comments

Comments
 (0)