docs: add doc

weimobGroup · Jul 14, 2021 · 67d4b87 · 67d4b87
1 parent 863520d
commit 67d4b87
Show file tree

Hide file tree

Showing 18 changed files with 502 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -102,3 +102,6 @@ dist
 
 # TernJS port file
 .tern-port
+
+
+.DS_Store
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,22 @@
+# WeConsole 贡献指南
+
+我们非常欢迎社区的开发者向 WeConsole 做出贡献。在提交贡献之前，请花一些时间阅读以下内容，保证贡献是符合规范并且能帮助到社区。
+
+## 提交 commit
+
+整个 WeConsole 仓库遵从 [Angular Style Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153)，在输入 commit message 的时候请务必遵从此规范。
+
+## 代码风格
+
+-   `JavaScript`：JavaScript 风格遵从 [JavaScript Standard Style](https://github.com/standard/standard)。
+-   `TypeScript`：TypeScript 风格也是 [JavaScript Standard Style](https://github.com/standard/standard) 的变种，详情请看相关包目录下的 `.eslintrc.js` 和 `tsconfig.json`。
+-   样式：遵循相关包目录下的 `.stylelintrc` 风格。
+
+## Pull Request 指南
+
+1. 务必保证 `npm run build` 能够编译成功；
+2. 务必保证提交的代码遵循相关包中的 `.eslintrc`, `.stylelintrc` 所规定的规范；
+3. 当相关包的 `package.json` 含有 `npm test` 命令时，必须保证所有测试用例都需要通过；
+4. 当相关包有测试用例时，请给你提交的代码也添加相应的测试用例；
+5. 提交代码 commit 时，commit 信息需要遵循 [Angular Style Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153)。
+6. 如果提交的代码非常多或功能复杂，可以把 PR 分成几个 commit 一起提交。我们在合并时会根据情况 squash。
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 weimobGroup
+Copyright (c) 2021 weimob
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
Original file line number	Diff line number	Diff line change
Expand Up		@@ -102,3 +102,6 @@ dist

		# TernJS port file
		.tern-port


		.DS_Store