pfan123 / repo

open source template

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

开源目的要素

  • 开源协议 LICENSE
  • 良好的项⽬目规范:
    • Git 分⽀支规范: Git 分⽀支规范
    • Git Workflow: Husky + ESLint + StyleLint + CommitLint
    • Commit Message: Git Commit Message
  • 需要包含的⽂文件:
    • .editorconfig
    • .gitignore
    • README.md
  • 自动化测试: Test, CI
  • Change log
  • README
  • 贡献指南
  • Github 相关的模板
    • ISSUE_TEMPLATE.md
    • PULLREQUESTTEMPLATE.md

注意: package.json中dependencies、devDependencies 的区别:dependencies 表示我们要在生产环境下使用该依赖,devDependencies 则表示我们仅在开发环境使用该依赖

About

open source template

License:MIT License


Languages

Language:JavaScript 100.0%