From 564af408e32a084ea52503ceea1561445f3bccd3 Mon Sep 17 00:00:00 2001 From: Justin Bottega <jubo.bot@openmailbox.org> Date: Mon, 13 Nov 2017 05:21:26 +0000 Subject: [PATCH] [docs] clarify guidelines for new contributors This adds the Contributor Covenant 1.2 from the previous guidelines, as well as a github workaround for new contributors who run into the 0xacab 1-repo limit (or similar issues). Replaces a 404 link in the leap-commit-template, and adds a reminders to anonymize logs for testers. - Documentation: #9138 Signed-off-by: Ruben Pollan <meskio@sindominio.net> --- README.rst | 9 +++++++-- docs/hacking/contributing.rst | 21 +++++++++++++++++---- docs/hacking/index.rst | 7 +++++++ docs/hooks/leap-commit-template.README | 2 +- docs/testing/index.rst | 9 ++++++--- 5 files changed, 38 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index 259c1c911..2591051ad 100644 --- a/README.rst +++ b/README.rst @@ -42,10 +42,15 @@ still available at the http://github.com/leapcode/bitmask_client repo). Read the Docs! ----------------------------------------------------------- -There is documentation about Bitmask `for users`_ and `for developers`_. +There is documentation about Bitmask `for users`_ and `for developers`_. For +developers, be sure to read the sections on `hacking`_ and `contributing_`. +Testers should read the section on `testing and QA`_. .. _`for users`: https://leap.se/en/docs/client -.. _`for developers`: https://bitmask.rtfd.io +.. _`for developers`: https://bitmask.readthedocs.io +.. _`hacking`: https://bitmask.readthedocs.io/en/latest/hacking/index.html +.. _`contributing`: https://bitmask.readthedocs.io/en/latest/hacking/contributing.html#contributing +.. _`testing and QA`: https://bitmask.readthedocs.io/en/latest/testing/index.html Bugs =========================================================== diff --git a/docs/hacking/contributing.rst b/docs/hacking/contributing.rst index 8d8359326..8dd0eb5c1 100644 --- a/docs/hacking/contributing.rst +++ b/docs/hacking/contributing.rst @@ -7,11 +7,24 @@ Contributing ============ -* Send your merge requests to https://0xacab/leap/bitmask-dev, it will be - subject to code-review. +This project adheres to the `Contributor Covenant 1.2`_. By participating you +are expected to uphold this code. Please report unacceptable behavior to +info@leap.se. + +* Fork the code at https://0xacab.org/leap/bitmask-dev. New users may be + limited in how many forks they can have, so if this is a problem for you, + file a `support ticket`_ or fork the code from the `github mirror`_. +* Create a merge request on `0xacab`_. If you forked from the + `github mirror`_, create your pull request there. They will be subject to + code review. * Please base your branch for master, and keep it rebased when you push. * After review, please squash your commits. - + +.. _`Contributor Covenant 1.2`: http://contributor-covenant.org/version/1/2/0 +.. _`support ticket`: https://0xacab.org/riseup/0xacab/issues +.. _`github mirror`: https://github.com/leapcode/bitmask-dev +.. _`0xacab`: https://0xacab.org/leap/bitmask-dev + Coding conventions --------------------------------- @@ -57,4 +70,4 @@ in your gitconfig to only allow the merges that can be resolved as a fast-forward:: [merge] - ff = only + ff = only diff --git a/docs/hacking/index.rst b/docs/hacking/index.rst index 3cf6d3018..e651eb8a4 100644 --- a/docs/hacking/index.rst +++ b/docs/hacking/index.rst @@ -86,6 +86,13 @@ There are some :ref:`guidelines for contributing code <contributing>` that you might want to check if you are insterested in developing with Bitmask. +Submitting a Bug +---------------- + +You can read more about how to submit a bug in the section on +`Testing and QA <../testing/index>`_. + + Release ------- diff --git a/docs/hooks/leap-commit-template.README b/docs/hooks/leap-commit-template.README index e54c037d4..33ad01c18 100644 --- a/docs/hooks/leap-commit-template.README +++ b/docs/hooks/leap-commit-template.README @@ -43,4 +43,4 @@ should link to an issue in the bug tracker where the new feature is analyzed and documented. For a full example of how to write a good commit message, check out -https://github.com/sparkbox/how_to/tree/master/style/git +http://chris.beams.io/posts/git-commit/. diff --git a/docs/testing/index.rst b/docs/testing/index.rst index c83654c39..9f89597d6 100644 --- a/docs/testing/index.rst +++ b/docs/testing/index.rst @@ -23,18 +23,21 @@ Reporting bugs -------------- * Bug reports go into our `Issue Tracker`_. -* `Here`_ is some very good read about what constitutes a `good bug report`_. +* `Here`_ is a very good read about what constitutes a `good bug report`_. * Have also a look at the :ref:`Known Issues <issues>` page. .. _`Issue Tracker`: https://0xacab.org/leap/bitmask-dev/issues/ .. _`Here`: http://www.chiark.greenend.org.uk/~sgtatham/bugs.html .. _`good bug report`: http://www.chiark.greenend.org.uk/~sgtatham/bugs.html +.. note:: Before including logs in a bug report, please read through them and + *remove any personally-identifying information*! + Logs -------------- Bitmask stores the logs in ``$HOME/.config/leap/bitmaskd.log``. You might want -to remove the whole ``~/.config/leap`` folder when trying a new account, or when you -stop using Bitmask. +to remove the whole ``~/.config/leap`` folder when trying a new account, or +when you stop using Bitmask. Tips for QA -------------------------------- -- GitLab