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
+19-14Lines changed: 19 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,16 @@
1
1
# Contribute to SharePoint developer documentation
2
-
Below instructions explain how you can prepare your environment to contribute to SharePoint Developer Documentation.
2
+
These instructions explain how you can prepare your environment to contribute to SharePoint Developer Documentation.
3
3
4
4
## Docs repo structure
5
5
6
6
Before you decide to contribute, it is important to understand the `sp-dev-docs` repo structure so you can decide where to add your new doc or update an existing doc.
7
7
8
8
```
9
9
sp-dev-docs
10
-
--images
10
+
--assets
11
11
--docs
12
+
--general-development
13
+
--images
12
14
```
13
15
14
16
The `docs` folder contains the key developer topics:
@@ -30,20 +32,20 @@ The `spfx` folder contains documentation for SharePoint Framework. It is further
30
32
```
31
33
docs
32
34
--spfx
33
-
---webparts
35
+
---web-parts
34
36
-----basics
35
37
-----get-started
36
-
-----developer-guide
38
+
-----guidance
37
39
```
38
40
39
41
#### Component folder
40
42
Every component folder contains the following folders:
41
43
* basics
42
-
*`basics` folder contains concept docs that are helpful in building that particular component, for example: `webparts`.
44
+
*`basics` folder contains concept docs that are helpful in building that particular component, for example: `web-parts`.
43
45
* get-started
44
-
*`get-started` folder contains walkthroughs and tutorials on how to get started building that particular component, for example: `webparts`.
45
-
*developer-guide
46
-
*`developer-guide` folder contains guides, best practices and reference implementations for that particular component, for example: `webparts`.
46
+
*`get-started` folder contains walkthroughs and tutorials on how to get started building that particular component, for example: `web-parts`.
47
+
*guidance
48
+
*`guidance` folder contains guides, best practices and reference implementations for that particular component, for example: `web-parts`.
47
49
*
48
50
Any images associated with the docs should be uploaded into the `sp-dev-docs\images` folder.
49
51
@@ -80,9 +82,10 @@ Now that you have forked the docs repository, to sync this forked repository to
80
82
81
83

82
84
83
-
If you have any Git Desktop or any git source control installed, you can click the `Open is Desktop`, else follow the steps below:
85
+
If you have any Git Desktop or any git source control installed, you can click the `Open in Desktop` or follow the steps below:
84
86
85
-
In the Clone with HTTPs section, click to copy the clone URL for the repository.
87
+
In the `Clone with HTTPs` section, click 
88
+
to copy the clone URL for the repository.
86
89
87
90
* Open your favorite console terminal.
88
91
@@ -132,16 +135,18 @@ Once you have completed adding your changes, you can submit a pull request.
132
135
133
136
Navigate to the forked sp-dev-docs repo in your account. Make sure your current branch is `master` branch.
134
137
135
-
Once you are in the `master` branch, you should see a message to `Compare & pull request`
138
+
Once you are in the `master` branch, you should see a message stating `This branch is 1 commit ahead of SharePoint:master` and next to it will be a `Pull request` link.
136
139
137
140

138
141
139
-
This will start a new pull request. Make sure you use the following [template]() to fill in your changes. Make sure you are creating this pull request against the `master` branch.
142
+
Click the `Pull request` link to start a new pull request. Make sure you use this [template](PULL_REQUEST_TEMPLATE.md) to fill in your changes. Make sure you are creating this pull request against the `master` branch.
143
+
144
+
Once you have all the information, click the `Create pull request` button to submit your pull request.
140
145
141
-
Once you have all the information, click the `Create pull request` to submit your pull request.
## Syncing your forked repository to keep it up-to-date with the upstream repository
144
149
145
150
In order to keep your forked sp-dev-docs repo up-to-date with the parent repository, you will need to first [configure a remote that points to upstream repository](https://help.github.com/articles/configuring-a-remote-for-a-fork).
146
151
147
-
Once you have configured the upstream repository, follow the steps [here](https://help.github.com/articles/configuring-a-remote-for-a-fork) to sync your fork to keep it up-to-date with the upstream repository.
152
+
Once you have configured the upstream repository, follow the steps [here](https://help.github.com/en/articles/syncing-a-fork) to sync your fork to keep it up-to-date with the upstream repository.
0 commit comments