How to make your open source project more expressive?

Sowing hope

What I'm talking about today is not pure technical dry goods, but some tools used by the author in open source projects, which can make our open source projects more expressive . Finally, I will synchronize the H5-Dooring  page editor and V6. Some updates to the visual large-screen editor.

How to make your open source project have a beautiful README.md?

After shopping around the community, the author found outreadme-md-generator

readme-md-generator suggests that we use the corresponding readme structure by reading our package.json and git configuration.

The generated README.md is similar to the following display:

In addition, an excellent one package.jsonshould contain the following metadata :

{
  "name": "H5-Dooring",
  "version": "1.1.3",
  "description": "H5-Dooring是一款功能强大,开源免费的H5可视化页面配置解决方案,致力于提供一套简单方便、专业可靠、无限可能的H5落地页最佳实践。技术栈以react为主, 后台采用nodejs开发。",
  "author": "作者信息",
  "license": "开源协议",
  "homepage": "主页地址",
  "repository": {
    "type": "git",
    "url": "git仓库地址"
  },
  "bugs": {
    "url": "供他人提issue的地址"
  },
  "engines": {
    "npm": ">=5.5.0",
    "node": ">=9.3.0"
  }
}

You can also refer to the above specifications when working on open source projects to make your open source projects more reliable and robust~

Use git-emoji to visualize your code submission

git-emojiIt is an emoji guide for git submission information. We submit log logs in accordance with its specifications, and an easy-to-understand submission emoji will be generated, as follows:

The more famous open source project submissions we have seen will have an image, emojiand they all follow the corresponding submission specifications. The following is its introduction website:

Online address: https://gitmoji.js.org/

We can use its guide to easily optimize our open source submission log, so hurry up and try it~

H5-Dooring editor update log

  1. Add barcode component

  2. Fix the multi-page jump association bug

  3. Fix the rich text editing switching bug in component interaction

  4. Data visualization big screen release

Near-term planning

  1. Dooring2.0 version plan

  2. Form designer adds insert function

  3. Add component animation

  4. Optimize DSL structure, renderer

  5. Support downloading source code

Address: http://h5.dooring.cn

V6.Dooring update log

The internal beta version is currently open for everyone to test and learn. We will continue to optimize bugs and iterative functions in the future, so stay tuned.

Address: http://175.27.130.220:3001/beta

Guess you like

Origin blog.csdn.net/KlausLily/article/details/114859858