From feb41f22c85e805b59e75935fe6eaf43927922df Mon Sep 17 00:00:00 2001 From: Victor Gaydov Date: Fri, 6 Oct 2023 18:06:48 +0400 Subject: [PATCH] Update sphinx docs --- docs/sphinx/development/coding_guidelines.rst | 19 +++++++++++++++++++ .../development/contribution_guidelines.rst | 15 +++++---------- 2 files changed, 24 insertions(+), 10 deletions(-) diff --git a/docs/sphinx/development/coding_guidelines.rst b/docs/sphinx/development/coding_guidelines.rst index da2ca9bc6..adaf7eea1 100644 --- a/docs/sphinx/development/coding_guidelines.rst +++ b/docs/sphinx/development/coding_guidelines.rst @@ -131,6 +131,25 @@ Coding style * Use upper case SNAKE_CASE for macros, CamelCase for class names, and lower case snake_case for methods, functions, fields, and variables. Add trailing underscore\_ for private methods and fields. +.. raw:: html + + + +* Members in class should have the following order: + + * public members: + * types and constants + * methods + + * protected members: + * types and constants + * methods + + * private members: + * types and constants + * methods + * fields + .. raw:: html diff --git a/docs/sphinx/development/contribution_guidelines.rst b/docs/sphinx/development/contribution_guidelines.rst index 6738c91fd..559b2a381 100644 --- a/docs/sphinx/development/contribution_guidelines.rst +++ b/docs/sphinx/development/contribution_guidelines.rst @@ -5,25 +5,18 @@ Contribution guidelines :local: :depth: 1 -Community -========= - -Welcome to join our Matrix chats and mailing list! - -Please refer :doc:`this page ` for more details. - How you can help ================ * **Contributing code** - We are always happy to meet new people in the project. Please refer to the section below for details on the onboarding process. + We are always happy to meet new people in the project. For details on the onboarding process, see below. * **Testing** - We also appreciate help in testing new releases. We highly depend on feedback from users to identify bugs and receive suggestions for new features. + We appreciate help in testing on various OSes and hardware, and highly depend on feedback from users. If you wish to test, you can look for tutorials on :doc:`publications page `. -* **Writing tutorials** +* **Writing** If you've built Roc for a niche OS or hardware, or tweaked settings to make it work better for your needs, we'd love if you share your experience with the community. If you wrote a guide, you can send it to us to be added to the :doc:`publications page `. @@ -32,6 +25,8 @@ Becoming a contributor First of all, thank you for your interest! We welcome and appreciate all help. Many important features were submitted by :doc:`numerous contributors `, and we are really grateful for that. +In case of any questions, welcome to join our :doc:`chat and mailing list `. + The guide bellow will help you to prepare your first patch. * **Step 1: Checkout and build project**