Skip to content

Commit fe48fe3

Browse files
Dscanokoushikcs562
authored andcommitted
Centralize P4 learning materials in README (#43)
- Move learning resources into README - Remove duplicate learning_materials.md - Fix badge year and restore About section - Resolve conflicts and cleanup Signed-off-by: Cs Koushik <[email protected]>GSoC 2026 (#42) In this PR, I have set up the GSoC 2026 folder and files . I Have added a new file called `project_rules `file containing basic rules that students have to follow. This file is inspired by the [ScummVM Project Rules](https://wiki.scummvm.org/index.php?title=Summer_of_Code/Project_R
1 parent 886ab21 commit fe48fe3

File tree

2 files changed

+58
-3
lines changed

2 files changed

+58
-3
lines changed

2026/application_instructions.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1+
<<<<<<< Updated upstream
2+
# Contributor Guidance
3+
4+
<<<<<<<< Updated upstream:2026/application_instructions.md
5+
=======
16
# P4 GSoC 2026 Contributor Guidance
27

8+
>>>>>>> Stashed changes
39
## Before the Application
410

511
- Go through the general GSoC
@@ -9,9 +15,32 @@
915
- Check out our
1016
[organization profile](https://summerofcode.withgoogle.com/programs/2025/organizations/the-p4-language-consortium),
1117
[learning materials](/materials/learning_materials.md),
18+
<<<<<<< Updated upstream
1219
[contributor guidance](/materials/lcontributor_guidance.md), which are mandatory for all contributors, and the
1320
[ideas list](ideas_list.md)
1421
to see if they fit your interests and skills.
22+
========
23+
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.
24+
25+
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.
26+
27+
## Before you apply
28+
>>>>>>>> Stashed changes:2026/contributor_guidance.md
29+
30+
- **Managing Commitments and Avoiding Burnout During GSoC**
31+
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>
32+
33+
- **Get in touch with us and our community**
34+
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.
35+
36+
- **Respect Mentors, Deliver on Time**
37+
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.
38+
39+
<<<<<<<< Updated upstream:2026/application_instructions.md
40+
=======
41+
[contributor guidance](contributor_guidance.md), which are mandatory for all contributors, and the
42+
[ideas list](ideas_list.md)
43+
to see if they fit your interests and skills.
1544

1645
## Application Process
1746

@@ -25,6 +54,7 @@
2554

2655
## Proposal Template
2756

57+
>>>>>>> Stashed changes
2858
- Please follow this
2959
[guide](https://google.github.io/gsocguides/student/writing-a-proposal)
3060
and use these examples ([1](https://google.github.io/gsocguides/student/proposal-example-1) &
@@ -55,10 +85,37 @@
5585
- 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.
5686
- Please attach the link to your pull request in the proposal.
5787
**Project Timeline**
88+
<<<<<<< Updated upstream
89+
========
90+
91+
- **NO LLM-generated code or texts are accepted**
92+
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.
93+
94+
95+
## Before you are accepted
96+
>>>>>>>> Stashed changes:2026/contributor_guidance.md
97+
98+
- **Prepare a Comprehensive and Detailed Plan**
99+
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.
100+
101+
102+
## During GSoC
103+
104+
- **Choose Your Communication Method**
105+
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.
106+
107+
- **Deliverables**
108+
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.
109+
110+
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.
111+
112+
The report template can be found here:[report template](report_template.md)
113+
=======
58114

59115
## Communication Channels
60116

61117
- For general P4 related questions, use the [P4 forum](https://forum.p4.org).
62118
- For more real-time and personal communications, use our [Zulip workspace](https://p4lang.zulipchat.com/).
63119
- For GSoC related discussion, we have a `#gsoc` channel on Zulip.
64120
- For other communication channels, check out https://p4.org/join/.
121+
>>>>>>> Stashed changes

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,4 @@ For all our projects, it’s good to know some P4. Here are some learning materi
3131
- [Understanding the Open-Source P416 Compiler (Feb 15, 2022) – Mihai Budiu](https://www.youtube.com/watch?v=Rx5AQ0IF6eU)
3232
- [Understanding P416 Compiler, Part 2 (Mar 1, 2022) – Mihai Budiu](https://www.youtube.com/watch?v=YnPHPaPSmpU)
3333
- [Compiler Design PDF](https://github.com/p4lang/p4c/blob/main/docs/compiler-design.pdf)
34-
- Introduction to P4Runtime: [Next-Gen SDN Tutorial – Session 1](https://www.youtube.com/watch?v=KRx92qSLgo4)
35-
36-
> These resources were previously located in `contributor_guidance.md` and are now centralized here for easier access.
34+
- Introduction to P4Runtime: [Next-Gen SDN Tutorial – Session 1](https://www.youtube.com/watch?v=KRx92qSLgo4)

0 commit comments

Comments
 (0)