Merge branch 'origin/centralize-learning-materials' into centralize-learning-materials

Resolve README.md conflict and update learning materials

Author: koushikcs562

2024/contributor_guidance.md

@@ -7,7 +7,8 @@
   [timeline](https://developers.google.com/open-source/gsoc/timeline), and
   [contributor guide](https://google.github.io/gsocguides/student).
 - Check out our
-  [organization profile](https://summerofcode.withgoogle.com/programs/2024/organizations/the-p4-language-consortium) and
+  [organization profile](https://summerofcode.withgoogle.com/programs/2024/organizations/the-p4-language-consortium),
+  [learning materials](/materials/learning_materials.md), and
   [ideas list](ideas_list.md)
   to see if they fit your interests and skills.
 - **February 22 - March 18**

2025/contributor_guidance.md

@@ -10,7 +10,8 @@
   [timeline](https://developers.google.com/open-source/gsoc/timeline), and
   [contributor guide](https://google.github.io/gsocguides/student).
 - Check out our
-  [organization profile](https://summerofcode.withgoogle.com/programs/2025/organizations/the-p4-language-consortium) and
+  [organization profile](https://summerofcode.withgoogle.com/programs/2025/organizations/the-p4-language-consortium),
+  [learning materials](/materials/learning_materials.md), and
   [ideas list](ideas_list.md)
   to see if they fit your interests and skills.
 

2026/contributor_guidance.md renamed to 2026/application_instructions.md

@@ -1,16 +1,15 @@
 # P4 GSoC 2026 Contributor Guidance
 
-> [!Warning]
-> Please note that proposals completely generated using Large Language Models (LLMs) will not be accepted. Using LLM to assist you is acceptable, but letting LLM replace you is not. If you do use LLM, use your best judgement to use it responsibly. During the application process, if we find out it's easier to work with an LLM directly than working with you, it will be an immediate reject.
-
 ## Before the Application
 
 - Go through the general GSoC
   [FAQ](https://developers.google.com/open-source/gsoc/faq),
   [timeline](https://developers.google.com/open-source/gsoc/timeline), and
   [contributor guide](https://google.github.io/gsocguides/student).
 - Check out our
-  [organization profile](https://summerofcode.withgoogle.com/programs/2025/organizations/the-p4-language-consortium) and
+  [organization profile](https://summerofcode.withgoogle.com/programs/2025/organizations/the-p4-language-consortium),
+  [learning materials](/materials/learning_materials.md),
+  [contributor guidance](/materials/lcontributor_guidance.md), which are mandatory for all contributors, and the
   [ideas list](ideas_list.md)
   to see if they fit your interests and skills.
 
@@ -55,22 +54,7 @@
     - Please read [this guide](https://developers.google.com/blockly/guides/contribute/get-started/write_a_good_pr) on how to write a good pull request first.
     - The pull request doesn’t have to be merged for the qualification task to be considered complete. But if you can manage to get it merged, that’s a bonus point for your application.
     - Please attach the link to your pull request in the proposal.
-
-## P4 Learning Materials
-
-For all our projects, it’s good to know some P4. Here are some learning materials:
-
-- General hands-on tutorials: https://github.com/p4lang/tutorials
-- Technical documentation on P4 related topics: https://github.com/jafingerhut/p4-guide?tab=readme-ov-file#introduction
-- Motivating P4: [IEEE ICC 2018 // Keynote: Nick McKeown, Programmable Forwarding Planes Are Here To Stay](https://www.youtube.com/watch?v=8ie0FcsN07U)
-- Introducing P4-16 in detail:
-  - Part 1: [Introduction to P4_16. Part 1](https://www.youtube.com/watch?v=GslseT4hY1w)
-  - Part 2: [Introduction to P4_16. Part 2](https://www.youtube.com/watch?v=yqxpypXIOtQ)
-- Material on the official P4 compiler:
-  - [Understanding the Open-Soure P416 Compiler - February 15, 2022 - Mihai Budiu](https://www.youtube.com/watch?v=Rx5AQ0IF6eU)
-  - [Understanding P416 Open-Source Compiler, Part 2 - March 1, 2022 - Mihai Budiu](https://www.youtube.com/watch?v=YnPHPaPSmpU)
-  - https://github.com/p4lang/p4c/blob/main/docs/compiler-design.pdf
-- Introduction to P4Runtime: [Next-Gen SDN Tutorial - Session 1: P4 and P4Runtime Basics](https://www.youtube.com/watch?v=KRx92qSLgo4)
+    **Project Timeline**
 
 ## Communication Channels
 

materials/contributor_guidance.md

@@ -0,0 +1,42 @@
+# Contributor Guidance
+
+Here you will find several important rules which you have to agree to follow in order to be eligible to apply as a contributor for the P4 Language Consortium.
+
+These rules are intended to make the program rewarding and problem-free for everyone involved. They are based on our experience with GSoC and are designed to help you get the most out of it.
+
+## Before you apply
+
+- **Managing Commitments and Avoiding Burnout During GSoC**
+Please note that Google Summer of Code requires a time commitment of 20-40 hours per week, depending on the size of the tasks you choose. If you're considering taking on an additional part-time job, have extensive exams, or plan an extended vacation during the program, you need to carefully evaluate whether you can manage all these commitments without risking burnout. To help us better assess your availability, <ins>please make sure to explicitly list any other obligations in your application.</ins>
+
+- **Get in touch with us and our community**
+ In particular, visit our [Zulip workspace](https://p4lang.zulipchat.com/), [P4 forum](https://forum.p4.org), [P4 Linkdin](https://www.linkedin.com/company/p4-language-consortium/) and/or email the mentors listed on the [ideas list](ideas_list.md) for each project that sounds appealing to you.
+
+- **Respect Mentors, Deliver on Time**
+The P4 Language Consortium values your enthusiasm and willingness to contribute. However, contacting mentors on multiple platforms, sending repeated messages, or asking for shortcuts may be viewed as unprofessional. Likewise, requesting last-minute reviews or urgent feedback when you are close to a deadline can be interpreted as a lack of reliability. Please remember that P4 mentors and admins volunteer their time to support a meaningful and successful GSoC experience.
+
+
+- **NO LLM-generated code or texts are accepted**
+Please note that proposals completely generated using Large Language Models (LLMs) will not be accepted. Using LLM to assist you is acceptable, but letting LLM replace you is not. If you do use LLM, use your best judgement to use it responsibly. During the application process, if we find out it's easier to work with an LLM directly than working with you, it will be an immediate reject.
+
+
+## Before you are accepted
+
+- **Prepare a Comprehensive and Detailed Plan**
+Within your project proposal, please include a section with a clear timeline detailing your 12-week project plan. Be sure to note any existing commitments, such as exams, vacations, or other obligations—that could affect your availability.
+
+
+## During GSoC
+
+- **Choose Your Communication Method**
+Before starting the coding phase, a private Zulip channel dedicated to the GSoC project will be created as the main communication channel between mentors and the student. In addition, mentors and the student should agree on the communication approach they’ll use during the GSoC period—for example, using only the Zulip channel, having weekly sync-up calls, or any other method that works best for them.
+
+- **Deliverables**
+Before the end of the GSoC period, for the project to be considered successful, the student must complete all assigned tasks, submit a final project report, and present their work and results at the community kickoff and wrap-up meetings. The report may be used directly as a blog post. For particularly complex projects, and if the student is willing, an additional blog article can be prepared and published on the P4 Language Consortium blog.
+
+Students may use any preferred approach to prepare their report, article, and presentations. One suggested method is the laboratory-diary approach: keeping a private log of task progress helps track the work and simplifies the preparation of the final deliverables.
+
+The report template can be found here: [report template](report_template.md). For any insigths here a few example reports that we think is of high quality and roughly follows the template:
+
+- [2025 GSoC - Bmv2 Pkt Out - Xiyu Hao](/2025/projects/bmv2_pkt_out/README.md)
+- [2024 GSoC - Container Migration - Stanislav Kosorin](/2024/projects/container_migration/README.md)

materials/learning_materials.md

@@ -0,0 +1,15 @@
+# P4 Learning Materials
+
+For all our projects, it’s good to know some P4. Here are some learning materials:
+
+- General hands-on tutorials: https://github.com/p4lang/tutorials
+- Technical documentation on P4 related topics: https://github.com/jafingerhut/p4-guide?tab=readme-ov-file#introduction
+- Motivating P4: [IEEE ICC 2018 // Keynote: Nick McKeown, Programmable Forwarding Planes Are Here To Stay](https://www.youtube.com/watch?v=8ie0FcsN07U)
+- Introducing P4-16 in detail:
+  - Part 1: [Introduction to P4_16. Part 1](https://www.youtube.com/watch?v=GslseT4hY1w)
+  - Part 2: [Introduction to P4_16. Part 2](https://www.youtube.com/watch?v=yqxpypXIOtQ)
+- Material on the official P4 compiler:
+  - [Understanding the Open-Soure P416 Compiler - February 15, 2022 - Mihai Budiu](https://www.youtube.com/watch?v=Rx5AQ0IF6eU)
+  - [Understanding P416 Open-Source Compiler, Part 2 - March 1, 2022 - Mihai Budiu](https://www.youtube.com/watch?v=YnPHPaPSmpU)
+  - https://github.com/p4lang/p4c/blob/main/docs/compiler-design.pdf
+- Introduction to P4Runtime: [Next-Gen SDN Tutorial - Session 1: P4 and P4Runtime Basics](https://www.youtube.com/watch?v=KRx92qSLgo4)

materials/report_template.md

@@ -0,0 +1,47 @@
+**Contributor**: Name Contributor ([@githubContributor])
+
+**Mentors**: Name Mentor ([@githubMentor]), etc
+
+[@githubContributor]: https://github.com/githubContributor
+[@githubMentor]: https://github.com/githubMento
+
+## Table of Contents
+- [Report Template](#report-template)
+  - [Table of Contents](#table-of-contents)
+  - [Abstract](#abstract)
+  - [Implementation details](#implementation-details)
+    - [Subsection](#Subsection)
+  - [Demo](#demo)
+  - [Results](#results)
+  - [Future Work](#future-work)
+
+## Abstract
+An effective abstract is a short and clear summary of your report (usually 1–2 paragraphs) that helps readers quickly understand the main ideas without having to read the whole text[[1]](#1-https://www.cambridge.org/core/services/authors/writing-an-effective-abstract). It should:
+- Include key terms related to your topic.
+- Use clear, accessible language, with minimal unexplained technical jargon.
+- Highlight the most interesting and important aspects of your work immediately.
+
+## Implementation Details
+It contains a detailed explanation of the work implemented during the GSoC period.
+More specifically, it provides the technical description of what has been done; the student may use images, code snippets, and similar material to support the explanation.
+For particularly complex or large tasks, subsections can be used to describe each task in detail. Each subsection should reference the relevant PRs and, when useful, include images, code snippets,etc.
+
+Relevant PRs:
+- https://SectionRelevantPR
+
+### Subsection
+Relevant PRs:
+- https://SubsectionRelevantPR
+
+## Demo
+This section provides the information required to compile, configure, and run the GSoC project. All necessary commands have to be listed and accompanied by a short description. Images showing the results should also be included and explained to demonstrate the obtained outcomes and to showcase that the implementation is functioning correctly.
+
+## Results
+In this section, the obtained results, such as implemented features, applications, tools, or measurements, have to be presented and discussed. More specifically, for work focused exclusively on software development, the completed objectives should be described and highlighted, while for measurements, graphs can be used to present the evaluated data together with comments that analyse and discuss the results.
+
+## Future Work
+Future work aims to provide an overview of possible improvements or enhancements to the developed GSoC project. In other words, it should give the reader a clear view of additional functionalities or possible improvements that could be implemented.
+
+## References
+
+##### [1]: [Writing an effective abstract](https://www.cambridge.org/core/services/authors/writing-an-effective-abstract)