diff options
| author | Daniel Watkins <oddbloke@ubuntu.com> | 2020-05-11 17:15:39 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-11 15:15:39 -0600 |
| commit | f9d041471c189463b0a8059bd9365d0c96ac7267 (patch) | |
| tree | 6aca69b9b64b27830e0bb6b1d9482f457223e980 | |
| parent | 73a5b3280ebb2823cb2751e37c5e2687aeb84088 (diff) | |
| download | vyos-cloud-init-f9d041471c189463b0a8059bd9365d0c96ac7267.tar.gz vyos-cloud-init-f9d041471c189463b0a8059bd9365d0c96ac7267.zip | |
HACKING.rst: guide people to add themselves to the CLA file (#349)
This (a) gives people an easy way of getting a commit into the codebase,
and (b) saves us from having to explain this process (or do it
ourselves) for every new contributor.
| -rw-r--r-- | HACKING.rst | 23 |
1 files changed, 20 insertions, 3 deletions
diff --git a/HACKING.rst b/HACKING.rst index ad00bf04..a4bc6ea6 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -6,10 +6,13 @@ This document describes how to contribute changes to cloud-init. It assumes you have a `GitHub`_ account, and refers to your GitHub user as ``GH_USER`` throughout. -Do these things once -==================== +Submitting your first pull request +================================== -* To contribute, you must sign the Canonical `contributor license agreement`_ +Follow these steps to submit your first pull request to cloud-init: + +* To contribute to cloud-init, you must sign the Canonical `contributor + license agreement`_ * If you have already signed it as an individual, your Launchpad user will be listed in the `contributor-agreement-canonical`_ group. @@ -57,11 +60,25 @@ Do these things once * Read through the cloud-init `Code Review Process`_, so you understand how your changes will end up in cloud-init's codebase. +* Submit your first cloud-init pull request, adding yourself to the + in-repository list that we use to track CLA signatures: + `tools/.github-cla-signers`_ + + * See `PR #344`_ and `PR #345`_ for examples of what this pull + request should look like. + + * (If you already have a change that you want to submit, you can + also include the change to ``tools/.github-cla-signers`` in that + pull request, there is no need for two separate PRs.) + .. _GitHub: https://github.com .. _Launchpad: https://launchpad.net .. _repository: https://github.com/canonical/cloud-init .. _contributor license agreement: https://ubuntu.com/legal/contributors .. _contributor-agreement-canonical: https://launchpad.net/%7Econtributor-agreement-canonical/+members +.. _tools/.github-cla-signers: https://github.com/canonical/cloud-init/blob/master/tools/.github-cla-signers +.. _PR #344: https://github.com/canonical/cloud-init/pull/344 +.. _PR #345: https://github.com/canonical/cloud-init/pull/345 Transferring CLA Signatures from Launchpad to Github ---------------------------------------------------- |