From 6562e8520d109bb4bf980d3cde8b248cdd532ff8 Mon Sep 17 00:00:00 2001 From: Deepak Khatri <lorforlinux@beagleboard.org> Date: Wed, 25 Sep 2024 01:07:58 +0530 Subject: [PATCH] Restrcuture how to contribute page content --- intro/contribution/how.rst | 60 +++++++++++++++++++------------------- 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/intro/contribution/how.rst b/intro/contribution/how.rst index 75f3d643..e895a5b0 100644 --- a/intro/contribution/how.rst +++ b/intro/contribution/how.rst @@ -31,6 +31,30 @@ With this you can easily provide us ideas, feedback, and create issues directly .. tip:: Reading the `help guide <https://openbeagle.org/help/>`_ is a great way to get started using OpenBeagle. +Suggesting enhancements +*********************** + +An issue doesn't have to be something wrong, it can just be about making something better. If in doubt how to make +a productive suggestion, hop on the forum and live chat groups to see what other people say. Check the current +ideas that are already out there and give us your idea. Try to be constructive in your suggestion. We are a primarily +a volunteer community looking to make your experience better, as those that follow you, and your suggestion could be +key in that endeavor. + +Where available, use the "enhancement" `label <https://openbeagle.org/help/user/project/labels.md>`_ on your issue +to make sure we know you are looking for a future improvement, not reporting something critically wrong. + +Submitting merge requests +************************* + +If you want to contribute to a project, the most practical way is with a +`merge request <https://openbeagle.org/help/user/project/merge_requests/index.html>`_. Start +by `creating a fork <https://openbeagle.org/help/user/project/repository/forking_workflow.html>`_, which +is your own copy of the project you can feel free to edit how you see fit. When ready, +`create a merge request <https://openbeagle.org/help/user/project/merge_requests/creating_merge_requests.html>`_ and +we'll review your work and give comments back to you. If suitable, we'll update the code to include your contribution! + +A bit more detailed suggestions can be found in the articles linked below. + .. _docs-site-editing-guide: Site Editing Guide @@ -243,16 +267,6 @@ below shows all the fields you have to update, Now wait for a review and, if comments are raised, then you can continue working on the project until everything looks perfect and your changes are merged in upstream. -.. _contribution-todo-list: - -Tackle to-do list -***************** - -This documentation has a number of ``todo`` items where help is needed that can be searched in the source. This list will -show up directly in the staging documentation at https://docs.beagleboard.io/latest/intro/contribution/how.html#contribution-todo-list - -.. todolist:: - Google Summer of Code (GSoC) **************************** @@ -271,29 +285,15 @@ Report issues on the software images at https://openbeagle.org/explore/topics/di Report issues on the hardware at https://openbeagle.org/explore/projects/topics/boards. -Suggesting enhancements -*********************** - -An issue doesn't have to be something wrong, it can just be about making something better. If in doubt how to make -a productive suggestion, hop on the forum and live chat groups to see what other people say. Check the current -ideas that are already out there and give us your idea. Try to be constructive in your suggestion. We are a primarily -a volunteer community looking to make your experience better, as those that follow you, and your suggestion could be -key in that endeavor. - -Where available, use the "enhancement" `label <https://openbeagle.org/help/user/project/labels.md>`_ on your issue -to make sure we know you are looking for a future improvement, not reporting something critically wrong. +.. _contribution-todo-list: -Submitting merge requests -************************* +Tackle to-do list +***************** -If you want to contribute to a project, the most practical way is with a -`merge request <https://openbeagle.org/help/user/project/merge_requests/index.html>`_. Start -by `creating a fork <https://openbeagle.org/help/user/project/repository/forking_workflow.html>`_, which -is your own copy of the project you can feel free to edit how you see fit. When ready, -`create a merge request <https://openbeagle.org/help/user/project/merge_requests/creating_merge_requests.html>`_ and -we'll review your work and give comments back to you. If suitable, we'll update the code to include your contribution! +This documentation has a number of ``todo`` items where help is needed that can be searched in the source. This list will +show up directly in the staging documentation at https://docs.beagleboard.io/latest/intro/contribution/how.html#contribution-todo-list -A bit more detailed suggestions can be found in the articles linked below. +.. todolist:: Articles on contribution ************************** -- GitLab