Skip to content

Commit 8a1d92e

Browse files
authored
📝 Update Memorial Wall Contribution guide
2 parents 0261f3b + f28938c commit 8a1d92e

File tree

10 files changed

+69
-22
lines changed

10 files changed

+69
-22
lines changed
82.8 KB
Loading
81.8 KB
Loading
26.9 KB
Loading
35.3 KB
Loading

doc/docs/en/contributing.md

Lines changed: 37 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -67,17 +67,43 @@ Open a new issue in our [GitHub Issues](https://github.com/ModelEngine-Group/nex
6767

6868
## 🌟 Quick Memorial Wall Contribution
6969

70-
Want to leave your mark on the Open Source Memorial Wall? Here's a simplified process designed especially for beginners:
71-
72-
### Super Simple Three Steps
73-
1. **Edit Online**: Click the ✏️ edit button on the [Memorial Wall file](https://github.com/ModelEngine-Group/nexent/blob/develop/doc/docs/en/opensource-memorial-wall.md) directly on GitHub
74-
2. **Add Your Message**: Add your message in the "Community Messages" section using this format:
75-
```markdown
76-
::: info Your Name - 2024-01-15
77-
Share your open source story or experience with Nexent!
78-
:::
79-
```
80-
3. **Submit PR**: Click "Propose changes" at the bottom, then "Create pull request"
70+
Want to leave your mark on the Open Source Memorial Wall? Here's a detailed step-by-step process designed especially for beginners:
71+
72+
### Step 1: Edit the Memorial Wall File
73+
74+
![Step 1](./assets/contribute_step_1.png)
75+
76+
**Instructions:** Click the ✏️ edit button on the [Memorial Wall file](https://github.com/ModelEngine-Group/nexent/blob/develop/doc/docs/en/opensource-memorial-wall.md) directly on GitHub
77+
78+
---
79+
80+
### Step 2: Add Your Message
81+
82+
![Step 2](./assets/contribute_step_2.png)
83+
84+
**Instructions:** Add your message in the "Community Messages" section using this format, then click "Commit changes":
85+
86+
```markdown
87+
::: info Your Name - 2024-01-15
88+
Share your open source story or experience with Nexent!
89+
:::
90+
```
91+
92+
---
93+
94+
### Step 3: Propose Changes
95+
96+
![Step 3](./assets/contribute_step_3.png)
97+
98+
**Instructions:** Click "Propose changes" and wait for the merge to complete!
99+
100+
---
101+
102+
### Step 4: Success!
103+
104+
![Step 4](./assets/contribute_step_4.png)
105+
106+
**Instructions:** After successful merge, it will be displayed on the GitHub homepage~ Congratulations on becoming one of Nexent's co-creators! 🎉
81107

82108
That's it! We'll review and merge your contribution as soon as possible. ✨
83109

198 KB
Loading
72.7 KB
Loading
45.6 KB
Loading
51.2 KB
Loading

doc/docs/zh/contributing.md

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -70,20 +70,41 @@ Gitflow 是一种结构化的 Git 分支管理模型,为软件开发提供了
7070

7171
## 🌟 开源纪念墙快速贡献
7272

73-
想要在开源纪念墙上留下您的印记吗?这是一个专门为初学者设计的简化流程:
74-
75-
### 超简单的三步走
76-
1. **在线编辑**:直接在 GitHub 网页上点击 [开源纪念墙文件](https://github.com/ModelEngine-Group/nexent/blob/develop/doc/docs/zh/opensource-memorial-wall.md) 右上角的 ✏️ 编辑按钮
77-
2. **添加留言**:在"社区留言"部分添加您的消息,使用以下格式:
78-
```markdown
79-
::: info 您的姓名 - 2024-01-15
80-
分享您的开源故事或对 Nexent 的使用体验!
81-
:::
82-
```
83-
3. **提交 PR**:点击页面底部"Propose changes",然后"Create pull request"
73+
想要在开源纪念墙上留下您的印记吗?这是一个专门为初学者设计的详细步骤流程:
74+
75+
### 步骤 1:编辑纪念墙文件
76+
77+
![步骤1](./assets/contribute_step_1.png)
78+
79+
**说明:** 在 GitHub 网页上点击开源纪念墙文件右上角的✏️编辑按钮
80+
81+
---
82+
83+
### 步骤 2:添加您的留言
84+
85+
![步骤2](./assets/contribute_step_2.png)
86+
87+
**说明:** 在文档末尾留言后点击 Commit changes
88+
89+
---
90+
91+
### 步骤 3:提交更改
92+
93+
![步骤3](./assets/contribute_step_3.png)
94+
95+
**说明:** 点击 Propose changes 等待合入就可以啦!
96+
97+
---
98+
99+
### 步骤 4:成功!
100+
101+
![步骤4](./assets/contribute_step_4.png)
102+
103+
**说明:** 合入成功后会在 GitHub 首页显示~ 恭喜您成为Nexent 共创者之一~ 🎉
84104

85105
就这么简单!我们会尽快审核并合并您的贡献。✨
86106

107+
87108
### 纪念墙贡献示例
88109
```markdown
89110
::: tip 开源新手 - 2024-01-15

0 commit comments

Comments
 (0)