vyos-documentation/CONTRIBUTING.md

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.

   git checkout -b fix-vxlan-typo
   

4. make your changes.

   Please check the documation, if you don't familiar with sphinx-doc or reStructuredText

   Note the following RFCs, which describe the reserved public IP addresses and autonomous system numbers for the documentation. RFC5737, RFC3849, RFC5389, RFC7042

   • 192.0.2.0/24
   • 198.51.100.0/24
   • 203.0.113.0/24
   • 2001:db8::/32
   • 16bit ASN: 64496 - 64511
   • 32bit ASN: 65536 - 65551
   • Unicast MAC Addresses: 00-53-00 to 00-53-FF
   • Multicast MAC-Addresses: 90-10-00 to 90-10-FF

Please don't use other public address space.

5. add the modified files

   git add path/to/filname
   

   or add all unstaged files

   git add .
   

6. commit your changes

   git commit -m "rename vxlan set syntax"
   

7. push your commits to your GitHub project:

   git push -u origin fix-vxlan-typo
   

8. 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.