diff options
| author | Daniel Thompson <daniel@redfelineninja.org.uk> | 2020-08-15 07:34:35 (GMT) |
|---|---|---|
| committer | Daniel Thompson <daniel@redfelineninja.org.uk> | 2020-08-15 07:34:35 (GMT) |
| commit | 8ceda3451db1d7482a60185d7cdde4dd6d5bf4bb (patch) | |
| tree | 470a57287863469dc51edbe8a8621bab5fdbf9a7 /docs | |
| parent | 52bc1ae188c297233c206b1ecabbdc03c65c9482 (diff) | |
contributing: Added a git quick fix howto
Suggested-by: Panagiotis Vasilopoulos <hello@alwayslivid.com>
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/code_of_conduct.rst | 3 | ||||
| -rw-r--r-- | docs/contributing.rst | 32 |
2 files changed, 30 insertions, 5 deletions
diff --git a/docs/code_of_conduct.rst b/docs/code_of_conduct.rst index 4071ffb..bf1ad54 100644 --- a/docs/code_of_conduct.rst +++ b/docs/code_of_conduct.rst @@ -1,6 +1,3 @@ -Code of Conduct ---------------- - Our Pledge ~~~~~~~~~~ diff --git a/docs/contributing.rst b/docs/contributing.rst index fd8bcdb..7e0957d 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -12,6 +12,9 @@ Anyone can contribute to the wasp-os project. Contributions are typically made via github using the typical fork-and-pull-request approach. Contributors who do not wish to use github are also welcome to share patches using ``git format-patch --to wasp-os@redfelineninja.org.uk`` and ``git send-email``. +In both cases, the code will be reviewed by a project maintainer, so please +anticipate review comments. Typically pull requests will not be merged if there +are open questions or requests for changes that have not been acted on. All contributions must include a ``Signed-off-by`` tag added by the contributor who submits the patch or patches. The ``Signed-off-by`` tag is added at the end @@ -42,7 +45,32 @@ patch append an appropriate line at the end of the commit message: Signed-off-by: Random Developer <r.developer@example.org> -Please use your real name, anonymous and pseudonymous contributions will not be -accepted. +Adding a sign-off can be automated by using git features such as +``git commit --signoff``. Please use your real name, anonymous and pseudonymous +contributions will not be accepted. + +Git Hints and Tricks +-------------------- + +Quick fixes +~~~~~~~~~~~ + +The most common review feedback for contributions to wasp-os is a request that +the contributor include their sign-off. For a single patch at the head of the +current branch (and shared as a github pull request) this can be handled fairly +easily: + +.. code-block:: sh + + git commit --amend --signoff + git push <myfork> HEAD + +Additionally, please be aware that github will not send out automatic +notifications to let the maintainer know that you have pushed an update to the +pull-request. Follow up the above with a comment on the pull request thread +saying that your contribution should be ready to go. + +Code of Conduct +--------------- .. include:: code_of_conduct.rst |