diff options
Diffstat (limited to 'docs/contributing')
| -rw-r--r-- | docs/contributing/build-vyos.rst | 2 | ||||
| -rw-r--r-- | docs/contributing/development.rst | 7 | ||||
| -rw-r--r-- | docs/contributing/documentation.rst | 2 | ||||
| -rw-r--r-- | docs/contributing/vyos_cli.rst | 2 |
4 files changed, 7 insertions, 6 deletions
diff --git a/docs/contributing/build-vyos.rst b/docs/contributing/build-vyos.rst index 8d191a9f..2ceaeda8 100644 --- a/docs/contributing/build-vyos.rst +++ b/docs/contributing/build-vyos.rst @@ -38,7 +38,7 @@ To be able to use Docker_, the current non-root user should be added to the Generating the container ----------------------- +------------------------ The container can built by hand or by fetching the pre-built one from DockerHub. Using the pre-built VyOS DockerHub organisation (https://hub.docker.com/u/vyos) will diff --git a/docs/contributing/development.rst b/docs/contributing/development.rst index 547c238b..f2fdb313 100644 --- a/docs/contributing/development.rst +++ b/docs/contributing/development.rst @@ -31,6 +31,7 @@ eases the automatic generation of a changelog file. A good approach for writing commit messages is actually to have a look at the file(s) history by invoking ``git log path/to/file.txt``. +.. _prepare_commit: Preparding patch/commit ^^^^^^^^^^^^^^^^^^^^^^^ @@ -81,12 +82,12 @@ post: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html * All text of the commit message should be wrapped at 72 characters if possible which makes reading commit logs easier with ``git log`` on a - standard terminal (which happens to be 80x25) + standard terminal (which happens to be 80x25) * If applicable a reference to a previous commit should be made linking those commits nicely when browsing the history: ``After commit abcd12ef - ("snmp: this is a headline") a Python import statement is missing, - throwing the follwoing exception: ABCDEF`` + ("snmp: this is a headline") a Python import statement is missing, + throwing the following exception: ABCDEF`` * Always use the ``-x`` option to the ``git cherry-pick`` command when back or forward porting an individual commit. This automatically appends the line: diff --git a/docs/contributing/documentation.rst b/docs/contributing/documentation.rst index 601688ee..40edf750 100644 --- a/docs/contributing/documentation.rst +++ b/docs/contributing/documentation.rst @@ -30,7 +30,7 @@ project maintainer can push to the official repository. This allows the maintainer to accept commits from any developer without giving them write access to the official codebase. -.. node:: Updates to our documentation should be delivered by a GitHub +.. note:: Updates to our documentation should be delivered by a GitHub pull-request. This requires you already have a GitHub account. * Fork this project on GitHub https://github.com/vyos/vyos-documentation/fork diff --git a/docs/contributing/vyos_cli.rst b/docs/contributing/vyos_cli.rst index 322b0be6..0dd288b0 100644 --- a/docs/contributing/vyos_cli.rst +++ b/docs/contributing/vyos_cli.rst @@ -183,7 +183,7 @@ Examples: * Bad: "Set TCP connection timeout" If a verb is essential, keep it. For example, in the help text of ``set system -ipv6 disable-forwarding`, "Disable IPv6 forwarding on all interfaces" is a +ipv6 disable-forwarding``, "Disable IPv6 forwarding on all interfaces" is a perfectly justified wording. Prefer infinitives |