Differences

This shows you the differences between two versions of the page.

--- gsoc:2025-gsoc-kworkflow [2025/02/01 14:15]
davidbtadokoro
+++ gsoc:2025-gsoc-kworkflow [2025/03/06 16:02] (current)
davidbtadokoro [Interact with the kw/patch-hub community!]
@@ Line 43: / Line 43: @@
 ==== Description ====
-As mentioned before, in the GSoC 2025 edition, we intend to focus on a single project on the ''kw'' sub-project ''patch-hub''. Linux kernel development is done via electronic mail and mailing lists, so instead of submitting Pull-Requests on GitHub through the web, contributions, reviews, and the like are done by sending emails to other developers and mailing lists.
+As mentioned before, in the GSoC 2025 edition, we intend to focus on a single project on the ''kw'' sub-project ''patch-hub''. Linux kernel development is done via electronic mail and mailing lists, so instead of submitting pull requests on GitHub through the web, contributions, reviews, and the like are done by sending emails to other developers and mailing lists.
 Software development based on email may seem a little confusing, especially if you have never heard of it, but the important point is that even though there are some arguments in favor of it, there are many inefficiencies and complexities that come with it.
-''patch-hub'', following ''kw'' spirit of
+''patch-hub'', following the ''kw'' spirit of simplifying workflows, aims to simplify the workflows of kernel developers when consuming from the development mailing lists. The tool is constructed as a Terminal UI (TUI), so it is a little less "roots" than a fully CLI system like the rest of ''kw'', but still no graphical interface 8-)
-This section will be updated ASAP as we are finishing the details, but, in the meanwhile, you can check out the [[https://github.com/kworkflow/patch-hub|patch-hub GitHub repo]] to get to know it better :)
+Below is a video of a simple demo of the tool. From listing the available development lists to consulting the flow of patchsets (a set of related patches, similar to a PR or an MR), their individual contents, and running actions on them, the tool aims to completely cover this part of kernel development.
-====Don't forget to interact with the kw Community====
+[[https://drive.google.com/file/d/1VriafRyLQ5RmWC1z5UxKv9lpM7GU0iOt/view?usp=drive_link|patch-hub demo video]]
-Interacting with kw as a tool and as a free software project is critical to grasp which of the above projects best suits you or to bring other ideas to the table. This means it's nice to use kw to understand its purposes and functionalities while also reporting bugs and suggesting enhancements (take a look at kw [[https://github.com/kworkflow/kworkflow/issues|reported issues]]). Don't be afraid to open pull requests addressing them! We really encourage you to do it!
+Don't forget to check out the [[https://github.com/kworkflow/patch-hub|patch-hub GitHub repo]].
-======Making your Project Proposal======
-The pre-requisites section is mandatory for everyone; for this reason, your final project proposal should have one section per assignment with two or three paragraphs that describe your experience with each task. Additionally, in your application, you must add print screens that follow the below instructions:
+==== Getting to Version 1 ====
-__Contact David to get one specific ID__
+As you can see in the demo video, ''patch-hub'' isn't in its initial stages, but there is a lot of work to be done. Currently, the latest released version is v0.1.4, and we are close to v0.2.0, which will be its beta.
-If you are really interested in this project, send a message to David and request one specific ID. You will need it for the next steps.
+With that being said, between the beta and v1.0.0, there are many tasks to be made, which we can highlight:
-__QEMU Setup__
+  * Redesign the architecture, as the technical debt is getting bigger
+  * Implement custom kernel build
+  * Implement inline review
+  * Make patchset reply with ''git send-email'' not teardown the UI
+  * Expand the unit test coverage, which is (being nice) small
+  * Enhance UI and UX
+  * And much more...
-For demonstrating your QEMU setup, you will need need to take a print screen of your entire desktop with QEMU running and with the following comment in your TTY:
+The idea is not to strictly get to v1.0.0 by the end of the program but to get as near as possible. At least, we need a solid and robust base that will streamline the rest of the work!
-  #kw 2024 GSoC <ID>
+==== Interact with the kw/patch-hub community! ====
-__For your custom kernel installation__
+Interacting with ''kw'' and ''patch-hub'' as a system/tool and a free software project is critical to grasping the dynamics and technical challenges you will face in your GSoC. This means it's nice to use ''kw'' and ''patch-hub'' to understand its purposes and functionalities while also reporting bugs and suggesting enhancements (take a look at ''patch-hub'' [[https://github.com/kworkflow/patch-hub/issues|reported issues]]). Don't be afraid to open pull requests addressing them! We really encourage you to do it!
-For showing that you were able to install a custom kernel in your VM system, add the following label in your kernel name suffix:
+===== As this edition focuses on patch-hub, we ask that you also focus the interaction on patch-hub. So, please open PRs, discuss issues, and the like on the [[https://github.com/kworkflow/patch-hub|patch-hub repo]]. =====
+====== Making your Project Proposal ======
+The **Warm Up** section is mandatory for everyone, so your final project proposal should have one section per assignment with two or three paragraphs describing your experience with each step of __Phase 1__. Additionally, in your application, you must add print screens that follow the below instructions:
+==== Contact David to get one specific ID ====
+If you are really interested in this project, email David and request one specific ID. You will need it for the next steps.
+==== QEMU Setup ====
+To demonstrate your QEMU setup, you will need to take a print screen of your entire desktop with QEMU running and with the following comment in your TTY:
+  #kw 2025 GSoC <ID>
+==== Custom Linux kernel Installation ====
+To show that you were able to install a custom kernel in your VM system, add the following label in your kernel name suffix:
   Kernel-<YOUR_NAME>-<YOUR_ID>
-  (( Replace YOUR_NAME by your first name, and YOUR_ID ))
+  (( Replace YOUR_NAME with your first name and YOUR_ID ))
 Install it in your QEMU VM; in the TTY, run the following command:
@@ Line 80: / Line 103: @@
 Take a print screen of the entire screen.
+==== Writing your Proposal ====
 Finally, make sure that you have the following section in your application:
   - One or two paragraphs about you;
-  - A couple of sections that describe your interaction with kw;
+  - A couple of sections that describe your interaction with ''kw''/''patch-hub'';
-  - Highlight some of your contributions to kw;
+  - Highlight some of your contributions to ''kw''/''patch-hub'';
-  - A project proposal to be executed in the GSoC timeline. Please, make sure that you add three main milestones (it should match with the GSoC evaluation date) and a work breakdown.
+  - A project proposal to be executed in the GSoC timeline. Please add three main milestones (it should match with the GSoC evaluation date) and a work breakdown.
+P.S.: Feel free to share your draft before submitting the final version.
+==== IMPORTANT NOTE ====
+As mentioned a couple of times, we are deadset on the ''patch-hub'' v1.0.0 project, and given the small number of mentors, we, with a heavy heart, won't be accepting other lines of project even if it is in the context of ''kw''.
+This doesn't mean we have an inflexible view of how the ''patch-hub'' project will be. Much of GSoC involves heavy interaction of contributors and mentors to produce the best free software code possible!
-P.s.: Feel free to share your draft before submitting the final version.

Wiki

User Tools

Site Tools

Differences

Page Tools