pinetime/wasp-os
1
0
Fork 0
Code Activity

contributing: Added a git quick fix howto

Browse source 
Suggested-by: Panagiotis Vasilopoulos <hello@alwayslivid.com>
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
This commit is contained in:
Daniel Thompson 2020-08-15 08:34:35 +01:00
parent 52bc1ae188
commit 8ceda3451d
2 changed files with 30 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/code_of_conduct.rst
View file

@ -1,6 +1,3 @@
Code of Conduct
---------------
Our Pledge
~~~~~~~~~~

32
docs/contributing.rst
View file

@ -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