Skip to content

Commit b0f6739

Browse files
author
barzanisar
authored
Adding complete step by step instructions to contribute
1 parent 62f33ce commit b0f6739

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

en/contribute/docs.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,15 @@ git clone https://github.com/<your git name>/px4_user_guide.git
5757
```sh
5858
npm install gitbook-cli -g
5959
```
60-
* Navigate to your local repository:
60+
> **Note** Everything you need to install and build Gitbook locally is also explained in the
61+
[toolchain documentation](https://toolchain.gitbook.com/setup.html).
62+
63+
* Navigate to your local repository and add original upstream:
6164
```sh
6265
cd ~/wherever/px4_user_guide
66+
git remote add upstream https://github.com/PX4/px4_user_guide.git
6367
```
64-
* To build your book, run:
68+
* Now you can checkout a new branch and add your changes. To build your book, run:
6569
```sh
6670
gitbook build
6771
```
@@ -80,14 +84,25 @@ gitbook serve
8084
```sh
8185
gitbook serve --port 4003
8286
```
83-
* You can output as html, pdf, epub or mobi:
87+
* You can also output as html, pdf, epub or mobi:
8488
```sh
8589
gitbook help
8690
```
91+
* Once you are satisfied with your changes after previewing them, you can add and commit them:
92+
```sh
93+
git add <file name>
94+
git commit -m "<your commit message>"
95+
```
96+
For a good commit message, please refer to [Contributing](../contribute/README.md) section.
8797

88-
Everything you need to install and build Gitbook locally is also explained in the
89-
[toolchain documentation](https://toolchain.gitbook.com/setup.html).
90-
98+
* Now you can push your local commits to your forked repository
99+
```sh
100+
git push origin <your feature branch name>
101+
```
102+
* You can verify that the push was successful by going to your forked repository in your browser: ```https://github.com/<your git name>/px4_user_guide.git```<br>
103+
There you should see the message that a new branch has been pushed to your forked repository.
104+
* Now it's time to create a pull request (PR). On the right hand side of the "new branch message" (see one step before), you should see a green button saying "Compare & Create Pull Request". Then it should list your changes and you can (must) add a meaningful title (in case of a one commit PR, it's usually the commit message) and message (<span style="color:orange">explain what you did for what reason</span>. Check [other pull requests](https://github.com/PX4/px4_user_guide/pulls) for comparison)
105+
* You're done! Responsible members of PX4 guides will now have a look at your contribution and decide if they want to integrate it. Check if they have questions on your changes every once in a while.
91106

92107
In overview:
93108

0 commit comments

Comments
 (0)