This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
gsoc:2024-gsoc-kworkflow [2024/02/07 19:57] davidbtadokoro [Project Idea] |
gsoc:2024-gsoc-kworkflow [2024/02/26 18:37] (current) davidbtadokoro [2024 GSoC - Kworkflow] |
||
---|---|---|---|
Line 10: | Line 10: | ||
Code License: GPLv2 | Code License: GPLv2 | ||
- | Mentor: David Tadokoro | + | Mentors: David Tadokoro <davidbtadokoro at gmail dot com> |
- | =====Brief about kworkflow===== | + | ======Brief about kworkflow====== |
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: | ||
Line 25: | Line 25: | ||
* https://blog.kworkflow.org/ | * https://blog.kworkflow.org/ | ||
- | =====Pre-requisites (warm-up)===== | + | ======Pre-requisites (warm-up)====== |
** ( ( This section is mandatory for everybody ) ) ** | ** ( ( This section is mandatory for everybody ) ) ** | ||
Line 41: | Line 41: | ||
=====Implement a Documentation Generator from Source==== | =====Implement a Documentation Generator from Source==== | ||
- | * **Size**: 1 contributor medium (175 hours), Level of difficulty: Medium | + | * **Size**: 1 contributor medium (175 hours), Level of difficulty: Intermediate |
* **Desired knowledge**: Bash, mechanisms like kernel-doc/javadoc | * **Desired knowledge**: Bash, mechanisms like kernel-doc/javadoc | ||
Line 66: | Line 66: | ||
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! | 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! | ||
- | =====How to prepare your project proposal===== | + | ======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: | 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: |