From 564af408e32a084ea52503ceea1561445f3bccd3 Mon Sep 17 00:00:00 2001 From: Justin Bottega Date: Mon, 13 Nov 2017 05:21:26 +0000 Subject: [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 --- README.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 259c1c91..2591051a 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 =========================================================== -- cgit v1.2.3