diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/hacking/contributing.rst | 21 | ||||
| -rw-r--r-- | docs/hacking/index.rst | 7 | ||||
| -rw-r--r-- | docs/hooks/leap-commit-template.README | 2 | ||||
| -rw-r--r-- | docs/testing/index.rst | 9 |
4 files changed, 31 insertions, 8 deletions
diff --git a/docs/hacking/contributing.rst b/docs/hacking/contributing.rst index 8d835932..8dd0eb5c 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 3cf6d301..e651eb8a 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 e54c037d..33ad01c1 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 c83654c3..9f89597d 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 -------------------------------- |