Skip to content

Commit

Permalink
Add contributing guideline
Browse files Browse the repository at this point in the history
  • Loading branch information
zxuqian committed May 1, 2024
1 parent 2f6d741 commit c2f38e9
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
15 changes: 14 additions & 1 deletion README-zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,17 @@

或者扫描下方二维码

<img src="./bilibili.jpg" width="250" alt="Bilibili 峰华前端工程师" />
<img src="./bilibili.jpg" width="250" alt="Bilibili 峰华前端工程师" />

## 贡献

欢迎贡献新特效示例!请按照以下步骤添加:

1. Fork 仓库。
2. 创建一个新分支,以 `feature/` 开头。
3. 参考现有的示例结构创建示例(注意最新的编号)。
4. 运行 `yarn run watch``npm run watch`。它会监控 `src/index.js` 中的更改,并编译到 `/index.js`,这个文件用于生成示例页面的 React 组件。
5. 更新 `src/index.js`。在 `uis` 数组的顶部添加示例名字和链接,并把 `newItem` 设置为 `true`,移除上一个示例的 `newItem` 属性。
6. 测试并提交 PR。

注意:你同意所贡献的代码可能会在我的一些视频中进行教学演示。
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,13 @@ Or scan the QR code below:

## Contributing

Currently, I have no contribution plans, but If you have any good examples, feel free to open an issue or submit a PR.
Contributing is welcome! Follow these steps to add your examples:

1. Fork this repository
2. Create a new branch, starting with `feature/`.
3. Structure your project according to the existing ones (note the latest numbering).
4. Run `yarn run watch` or `npm run watch`. This will monitor changes in `src/index.js` and compile it to `/index.js`, which is used to display React components for the demo page.
5. Update `src/index.js`. Add your example name and link at the top of the `uis` array, set `newItem` to `true`, and remove the `newItem` property from the previous item.
6. Test and issue a PR.

Notice: By contributing, you agree that your code may be used for demonstration in some of my videos.

0 comments on commit c2f38e9

Please sign in to comment.