Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions docs/contributing/cla.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
.. _cla:

#############################
Contributor License Agreement
#############################

Before we can accept your contributions to VyOS, you must sign a **Contributor
License Agreement (CLA)**.

This is a standard open-source practice designed to protect both you and the
project.

The process is simple and fully automated:

1. **Review the CLA document**

You can find the CLA text at our
`GitHub repository <https://github.com/vyos/vyos-cla-signatures/>`__.

2. **Submit a pull request**

When you open a pull request, a CLA bot will automatically check whether all
commit authors have signed the CLA.

3. **Follow the bot's instructions**

If the CLA has not been signed, the bot will leave a comment with a prompt.
Simply reply to that comment with the suggested text to sign the CLA.

4. **Wait for confirmation**

The CLA bot will verify your response and update the pull request status.
Once all commit authors have signed, the bot will confirm that the CLA
requirement has been met, and unlock the pull request for merging.

.. note::

The CLA must be signed by **each commit author**.

If your pull request includes commits from multiple contributors, each of
them must sign the CLA before the pull request can be accepted.

Once signed, the CLA remains valid for all past and future contributions to VyOS
made under the same GitHub identity.
5 changes: 5 additions & 0 deletions docs/contributing/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@
Submit a Patch
==============

.. warning::

Please read and sign the :doc:`Contributor License Agreement<cla>` before
submitting any patches.

Patches are always more than welcome. To have a clean and easy to maintain
repository we have some guidelines when working with Git. A clean repository
eases the automatic generation of a changelog file.
Expand Down Expand Up @@ -597,13 +602,13 @@

* ``set``

- https://github.com/vyos/vyatta-cfg/blob/0f42786a0b3/src/cstore/cstore.cpp#L352

Check warning on line 605 in docs/contributing/development.rst

View workflow job for this annotation

GitHub Actions / lint-doc / doc-lint

Line too long: len=82
- https://github.com/vyos/vyatta-cfg/blob/0f42786a0b3/src/cstore/cstore.cpp#L2549

Check warning on line 606 in docs/contributing/development.rst

View workflow job for this annotation

GitHub Actions / lint-doc / doc-lint

Line too long: len=83


* ``commit``

- https://github.com/vyos/vyatta-cfg/blob/0f42786a0b3/src/commit/commit-algorithm.cpp#L1252

Check warning on line 611 in docs/contributing/development.rst

View workflow job for this annotation

GitHub Actions / lint-doc / doc-lint

Line too long: len=93

.. include:: /_include/common-references.txt

Expand Down
6 changes: 6 additions & 0 deletions docs/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@
a deficit like most software projects. This not only helps you when reading
but also everyone else.

.. warning::

Please read and sign the
:doc:`Contributor License Agreement<contributing/cla>` before submitting any
documentation updates.

If you are willing to contribute to our documentation this is the definite
guide how to do so.

Expand Down Expand Up @@ -42,7 +48,7 @@
your text through a grammar and spell checker, such as `Grammarly`_.
- Don't forget to update ``index.rst`` when adding a new node.
- Try not to exceed 80 characters per line, but don't break URLs over this.
- Properly quote commands, filenames and brief code snippets with double backticks.

Check warning on line 51 in docs/documentation.rst

View workflow job for this annotation

GitHub Actions / lint-doc / doc-lint

Line too long: len=83
- Use literal blocks for longer snippets.
- Leave a newline before and after a header.
- Indent with two spaces.
Expand Down Expand Up @@ -83,9 +89,9 @@
1. Theoretical information
--------------------------

Theoretical information required for users to understand the next document sections:

Check warning on line 92 in docs/documentation.rst

View workflow job for this annotation

GitHub Actions / lint-doc / doc-lint

Line too long: len=84

- a simple explanation of what is this page about, why or when it is required to be used

Check warning on line 94 in docs/documentation.rst

View workflow job for this annotation

GitHub Actions / lint-doc / doc-lint

Line too long: len=90
- references to standards, RFCs

2. Configuration description
Expand Down Expand Up @@ -114,7 +120,7 @@

Described procedures for debugging a service:

- how to collect logs or other debugging information (like `show` commands output)

Check warning on line 123 in docs/documentation.rst

View workflow job for this annotation

GitHub Actions / lint-doc / doc-lint

Line too long: len=84
- how to read and what to search for in logs and collected information
- what are indicators of good and bad states in debugging outputs

Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@
.. grid-item-card:: Get / Build VyOS


Quickly :ref:`Build<contributing/build-vyos:build vyos>` your own Image or take a look at how to :ref:`download<installation/install:download>` a free or supported version.

Check warning on line 14 in docs/index.rst

View workflow job for this annotation

GitHub Actions / lint-doc / doc-lint

Line too long: len=178


.. grid-item-card:: Install VyOS

Read about how to install VyOS on :ref:`Bare Metal<installation/install:installation>` or in a

Check warning on line 19 in docs/index.rst

View workflow job for this annotation

GitHub Actions / lint-doc / doc-lint

Line too long: len=100
:ref:`Virtual Environment<installation/virtual/index:Virtual Environments>` and

Check warning on line 20 in docs/index.rst

View workflow job for this annotation

GitHub Actions / lint-doc / doc-lint

Line too long: len=85
how to use an image with the usual :ref:`cloud<installation/cloud/index:Cloud Environments>` providers


Expand Down Expand Up @@ -89,6 +89,7 @@

contributing/build-vyos
contributing/development
contributing/cla
contributing/issues-features
contributing/upstream-packages
contributing/debugging
Expand Down
Loading