summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorcurrite <53279076+currite@users.noreply.github.com>2019-08-07 19:58:13 +0200
committerGitHub <noreply@github.com>2019-08-07 19:58:13 +0200
commit30b4be7b92e444499b1501f1e1b9a263baa1044a (patch)
tree8804be0e0b5b73687581d5022a9380b932b80739 /CONTRIBUTING.md
parent8f4605b0061675a35951ca293f9871f2e75b6966 (diff)
downloadvyos-documentation-30b4be7b92e444499b1501f1e1b9a263baa1044a.tar.gz
vyos-documentation-30b4be7b92e444499b1501f1e1b9a263baa1044a.zip
Update CONTRIBUTING.md
Add explanations from Robert and other things I have needed.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md55
1 files changed, 46 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 496659bb..6610fe81 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,14 +1,17 @@
# Contributor's Guide
1. fork the project on GitHub https://github.com/vyos/vyos-documentation
-2. clone the fork
-3. create a a new branch for your work. You can use a name that describes what you do.
+2. clone the fork to your local machine
+ ```shell
+ git clone https://github.com/YOUR_USERNAME/vyos-documentation
+3. cd to your new local directory vyos-documentation
+4. create a a new branch for your work. You can use a name that describes what you do.
```shell
git checkout -b fix-vxlan-typo
```
-4. make your changes.
+5. make your changes.
- Please check the documation, if you don't familiar with [sphinx-doc](http://http://www.sphinx-doc.org) or [reStructuredText](http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html)
+ Please check the documentation if you aren't familiar with [sphinx-doc](http://http://www.sphinx-doc.org) or [reStructuredText](http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html)
Note the following RFCs, which describe the reserved public IP addresses and autonomous system numbers for the documentation. [RFC5737](https://tools.ietf.org/html/rfc5737), [RFC3849](https://tools.ietf.org/html/rfc3849), [RFC5389](https://tools.ietf.org/html/rfc5398), [RFC7042](https://tools.ietf.org/html/rfc7042)
@@ -23,8 +26,14 @@
Please don't use other public address space.
+6. Check your changes by locally building the documentation
+ ```shell
+ cd docs
+ make html
+ ```
+ Sphinx will build the html files in the docs/_build folder
-5. add the modified files
+7. add the modified files
```shell
git add path/to/filname
```
@@ -32,16 +41,44 @@
```shell
git add .
````
-6. commit your changes
+8. commit your changes
```shell
git commit -m "rename vxlan set syntax"
```
-7. push your commits to your GitHub project:
+9. push your commits to your GitHub project:
```shell
git push -u origin fix-vxlan-typo
```
-8. Submit a pull request.
+10. submit a pull request.
In GitHub, visit the main repository and you should see a banner
- suggesting to make a pull request. Fill out the form and describe what you do. \ No newline at end of file
+ suggesting to make a pull request. Fill out the form and describe what you do.
+
+11. once pull resquests have been approved, you may want to locally update your forked repository too. First you'll have to add the remote upstream repository.
+ ```shell
+ git remote add upstream https://github.com/vyos/vyos-documentation.git
+ ```
+
+ Check your configured remote repositories.
+ ```shell
+ git remote -v
+ origin https://github.com/YOUR_USERNAME/vyos-documentation.git (fetch)
+ origin https://github.com/YOUR_USERNAME/vyos.documentation.git (push)
+ upstream https://github.com/vyos/vyos-documentation.git (fetch)
+ upstream https://github.com/vyos/vyos-documentation.git (push)
+ ```
+
+ Your remote repo on Github is called Origin, while the original repo you have forked is called Upstream.
+
+ Now you can locally update your forked repo.
+ ```shell
+ git fetch upstream
+ git checkout master
+ git merge upstream/master
+ ```
+ If you want to update your fork on Github too:
+ ```shell
+ git push origin master
+ ```
+