Explorar el Código

add GSoC application guide

blueloveTH hace 2 años
padre
commit
f507e22325

+ 29 - 0
docs/gsoc/guide.md

@@ -0,0 +1,29 @@
+---
+icon: rocket
+order: 10
+label: "Application Guide"
+---
+
+Before starting, please read the [Ideas](./ideas.md) page and choose a project you are interested in.
+Set up a C++ compiler, clone pocketpy sources from github and try to build.
+This helps you confirm that your skills and experience match the requirements of the project.
+
+Your application should include the following:
+
+1. A brief introduction about yourself, including the most related open sourced project you have worked on before. It is highly recommended to attach your Github profile link.
+2. A technical proposal for the project you are interested in working on, including:
+    + Your understanding of the project.
+    + The technical approach/architecture you will adopt.
+    + The challenges you might face and how you will overcome them.
+3. A timeline for the project, including the milestones and deliverables.
+4. Other information required by the Google Summer of Code program.
+
+### Coding style guide
+
+See [Coding Style Guide](../coding_style_guide.md).
+
+### Contact
+
+If you have any questions, you can join our [Discord](https://discord.gg/WWaq72GzXv)
+or send an email to blueloveth@foxmail.com.
+We are glad to help you.

+ 5 - 0
docs/gsoc/ideas.md

@@ -0,0 +1,5 @@
+---
+icon: light-bulb
+order: 0
+label: "Project Ideas"
+---

+ 2 - 0
docs/gsoc/index.yml

@@ -0,0 +1,2 @@
+order: 19
+label: "GSoC"

+ 1 - 1
docs/quick-start/attr.md

@@ -1,6 +1,6 @@
 ---
 icon: dot
-label: 'Access attributes'
+label: 'Access Attributes'
 order: 80
 ---
 

+ 1 - 1
docs/quick-start/call.md

@@ -1,6 +1,6 @@
 ---
 icon: dot
-label: 'Call Python function'
+label: 'Call Python Function'
 order: 70
 ---
 

+ 1 - 1
docs/quick-start/config.md

@@ -1,6 +1,6 @@
 ---
 icon: dot
-label: 'Advanced config'
+label: 'Advanced Config'
 order: -2
 ---
 

+ 1 - 1
docs/quick-start/exec.md

@@ -1,6 +1,6 @@
 ---
 icon: dot
-label: 'Execute Python code'
+label: 'Execute Python Code'
 order: 93
 ---
 

+ 1 - 1
docs/quick-start/modules.md

@@ -1,6 +1,6 @@
 ---
 icon: dot
-label: 'Create modules'
+label: 'Create Modules'
 order: 50
 ---