diff options
| author | Justin Bottega <jubo.bot@openmailbox.org> | 2017-11-13 05:21:26 +0000 |
|---|---|---|
| committer | Ruben Pollan <meskio@sindominio.net> | 2017-11-20 19:10:45 +0100 |
| commit | 564af408e32a084ea52503ceea1561445f3bccd3 (patch) | |
| tree | b5ffd63a289ecf697ea8124700d50d20af971c08 /docs/hacking | |
| parent | 1a3d330f1dfffdd94f8091600bf477fef87dc233 (diff) | |
[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>
Diffstat (limited to 'docs/hacking')
| -rw-r--r-- | docs/hacking/contributing.rst | 21 | ||||
| -rw-r--r-- | docs/hacking/index.rst | 7 |
2 files changed, 24 insertions, 4 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 ------- |