gsoc:2022-gsoc-kworkflow
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
|
gsoc:2022-gsoc-kworkflow [2022/03/11 18:26] siqueira [2022 GSoC - Kworkflow] |
gsoc:2022-gsoc-kworkflow [2022/03/11 18:47] siqueira [How to prepare your project proposal] |
||
|---|---|---|---|
| Line 15: | Line 15: | ||
| Kworkflow, or just kw, is a tool that intends to simplify the kernel workflow by automating tasks such as: | Kworkflow, or just kw, is a tool that intends to simplify the kernel workflow by automating tasks such as: | ||
| - | - Manage kernel build; | + | - [[https://kworkflow.org/tutorials/buildlinux.html|Manage kernel build]]; |
| - | - Manage installation/removal of Linux on a target machine (local, remote, or VMs); | + | - [[https://kworkflow.org/tutorials/deploy-kernel.html|Manage installation/removal of Linux on a target machine (local, remote, or VMs)]]; |
| - | - Provide an easy way to collect basic information; | + | - [[https://kworkflow.org/tutorials/find-maintainers.html|Provide an easy way to collect basic information]]; |
| - | - Support working on DRM subsystem (we can expand to other subsystems); | + | - [[https://kworkflow.org/tutorials/configm.html|Manage config files]]; |
| - | - Manage config files. Etc; | + | - Support working on DRM subsystem (we can expand to other subsystems). Etc; |
| - | By using kw we expect to reduce the learning curve for newcomers and speed up everyday tasks executed by kernel developers in their workflow. Finally, the project should be reasonably easy to contribute since it is written in Bash, has extensive test coverage, and is documented from the code level to the user level. | + | |
| + | By using kw we expect to speed up everyday tasks executed by kernel developers in their workflow, provide a unified development experience, and reduce the learning curve for newcomers. Finally, the project should be reasonably easy to contribute since it is written in Bash, has extensive test coverage, follows a code style rule, it is documented from the code level to the user level. Don't believe it? Check by yourself: | ||
| + | * https://kworkflow.org/index.html | ||
| + | * https://app.codecov.io/gh/kworkflow/kworkflow | ||
| + | * https://github.com/kworkflow/kworkflow/pull/563/checks | ||
| =====Pre-requisites (warm-up)===== | =====Pre-requisites (warm-up)===== | ||
| ** ( ( This section is mandatory for everybody ) ) ** | ** ( ( This section is mandatory for everybody ) ) ** | ||
| + | |||
| + | ==== Part 1 ==== | ||
| + | |||
| If you are interested in this project, we have a few but essential pre-requisites for you to try before your application: | If you are interested in this project, we have a few but essential pre-requisites for you to try before your application: | ||
| Line 34: | Line 41: | ||
| - Basic Bash knowledge - https://www.gnu.org/software/bash/manual/bash.pdf (Read until Chapter 7) | - Basic Bash knowledge - https://www.gnu.org/software/bash/manual/bash.pdf (Read until Chapter 7) | ||
| - | =====Send your first patch to kw===== | + | ==== Part 2 ==== |
| It is highly recommended that you try to send a small contribution to kw. For helping you to see what could be a good start, take a look at this link: | It is highly recommended that you try to send a small contribution to kw. For helping you to see what could be a good start, take a look at this link: | ||
| - | * [[https://github.com/kworkflow/kworkflow/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22]] | + | https://github.com/kworkflow/kworkflow/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 |
| Finally, before you try to submit a patch, take a few minutes to read the following page: | Finally, before you try to submit a patch, take a few minutes to read the following page: | ||
| - | * https://siqueira.tech/doc/kw/content/howtocontribute.html | + | https://kworkflow.org/content/howtocontribute.html |
| + | If you could not complete the above topics or did not have fun doing it, this project may not fit you well. Don't worry, it's normal. I'm sure you will find some project that better suits your current skills and goals. | ||
| =====Project Idea===== | =====Project Idea===== | ||
| Line 52: | Line 60: | ||
| - Add support to generate dpkg versions of the kernel; | - Add support to generate dpkg versions of the kernel; | ||
| - Speed up kernel deploy to a machine; | - Speed up kernel deploy to a machine; | ||
| - | - Add support to Raspberry pi deploy; | ||
| - Expand the set of OS supported by kw; | - Expand the set of OS supported by kw; | ||
| Line 63: | Line 70: | ||
| __Contact Siqueira to get one specific ID__ | __Contact Siqueira to get one specific ID__ | ||
| - | If you are really interested in this project, send me a message to Siqueira and request one specific ID. You will need it for the next steps. | + | If you are really interested in this project, send a message to Siqueira and request one specific ID. You will need it for the next steps. |
| __QEMU Setup__ | __QEMU Setup__ | ||
| Line 73: | Line 80: | ||
| __For your custom kernel installation__ | __For your custom kernel installation__ | ||
| - | For showing that you were able to install a custom kernel machine in your VM system, add the following label in your kernel name suffix: | + | For showing 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> | Kernel-<YOUR_NAME>-<YOUR_ID> | ||
| Line 88: | Line 95: | ||
| - One or two paragraphs about you; | - 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; | ||
| - | - A list of your contribution to kw; | + | - Highlight some of your contributions to kw; |
| - 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, make sure that you 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 submit the final version. | + | P.s.: Feel free to share your draft before submitting the final version. |
gsoc/2022-gsoc-kworkflow.txt · Last modified: 2022/03/11 18:50 by siqueira
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
