Contributing Guiding (#18)

* add issue template

* contributing

Author: jolestar

.github/ISSUE_TEMPLATE/01_BUG_REPORT.md

@@ -0,0 +1,21 @@
+---
+name: Document Bug Report
+about: Create a report to help Starcoin Cookbook to improve
+title: "[bug]"
+labels: "bug"
+assignees: ""
+---
+
+# Document Bug Report
+
+**Document URL:**
+
+
+**Describe the document's bug:**
+
+<!-- Describe how the bug manifests. -->
+
+
+**Other information:**
+
+<!-- List any other information that is relevant to your issue. Related issues, suggestions on how to fix, Stack Overflow links, forum links, etc. -->

.github/ISSUE_TEMPLATE/02_QUESTION.md

@@ -0,0 +1,23 @@
+---
+name: Question
+about: Ask a Question about Starcoin and Move
+title: "[question]"
+labels: "question"
+assignees: ""
+---
+
+# Question
+
+**Describe the Question**
+
+<!-- A clear and concise description of the question, you can use any language you are good at, but preferred is English or Chinese -->
+
+<!--请准确清晰的描述您的问题，您可以用任意您擅长的语言，但最好是中文或者英文-->
+
+**Related Code**
+
+<!-- If you are able to illustrate the bug or feature request with an example, please provide it here. -->
+
+**Additional Context**
+
+<!-- List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to add, use case, Stack Overflow links, forum links, screenshots, OS if applicable, etc. -->

.github/ISSUE_TEMPLATE/03_DOC_IMPROVEMENT.md

@@ -0,0 +1,15 @@
+---
+name: Document improvement
+about: Provide your feedback for the existing documents or Suggestions for new documents.
+title: "[doc]"
+labels: "doc"
+assignees: ""
+---
+
+# Document Suggestion
+
+**Describe the Suggestion**
+
+<!-- A clear and concise description of the suggestion, you can use any language you are good at, but preferred is English or Chinese -->
+
+<!--请准确清晰的描述您关于文档改进的建议，您可以用任意您擅长的语言，但最好是中文或者英文-->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,2 @@
+---
+blank_issues_enabled: false

CODE_OF_CONDUCT.md

@@ -0,0 +1,45 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainer using any of the [conduct@starcoin.org](mailto:conduct@starcoin.org). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
+
+For answers to common questions about this code of conduct, see <https://www.contributor-covenant.org/faq>

README.md

@@ -1,37 +1,25 @@
 # Starcoin CookBook
 
-Learn how to build on Starcoin, the document url: https://starcoinorg.github.io/starcoin-cookbook/
+Learn how to build on Starcoin, the document URL: https://starcoinorg.github.io/starcoin-cookbook/
 
-### Installation
+### How to Contributing
 
-```
-$ yarn
-```
+First off, thanks for taking the time to contribute! Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are **greatly appreciated**.
 
-### Local Development
+Contributions in the following are welcome:
 
-```
-$ yarn start
-```
+1. Report a document bug.
+2. Submit a document suggestion.
+3. Contributing to write docuemnt. You can learn more about contributing to the Starcoin Cookbook by reading our [Contribution Guide](./docs/100-miscellaneous/99-contributing.md) |[贡献指南](./i18n/zh/docusaurus-plugin-content-docs/current/100-miscellaneous/99-contributing.md) 
 
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+You can view our [Code of Conduct](./CODE_OF_CONDUCT.md).
 
-### Build
+## Support
 
-```
-$ yarn build
-```
+Reach out to the maintainer at one of the following places:
 
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
-
-Then run serve to serving build directory at http://localhost:3000/starcoin-cookbook/
-```
-$ yarn serve
-```
-
-### Deployment
-
-The github action will auto deploy the documents.
+- [Starcoin Discord](https://discord.gg/starcoin)
+- [Starcoin Contributor Telegram group](https://t.me/starcoin_contributor)
 
 ### Links
 

docs/02-getting-started/01-install/README.md

@@ -2,7 +2,7 @@
 
 This article guides you on how to install starcoin.
 
-1. Download the binary for your operating system from github's [releases](https://github.com/starcoinorg/starcoin/releases) page. Starcoin supports Windows/Mac/Linux, unzip the binary and put it into the system bin path.
+1. Download the binary for your operating system from Github's [releases](https://github.com/starcoinorg/starcoin/releases) page. Starcoin supports Windows/Mac/Linux, unzip the binary and put it into the system bin path.
 2. Or [build from source](./build).
 3. Or [install by docker](./install-by-docker).
 
@@ -11,7 +11,7 @@ This article guides you on how to install starcoin.
 
 This document needs to be improved.
 
-* Add an one line install scripts for user easy install.
+* Add one-line install scripts for user easy install.
 * Add binary files description.
 
 :::

docs/03-move/01-prepare_move_env.md renamed to docs/03-move/01-prepare-move-env.md

@@ -0,0 +1,37 @@
+# Contribution Guide
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+Then run serve to serving build directory at http://localhost:3000/starcoin-cookbook/
+```
+$ yarn serve
+```
+
+
+:::note
+
+This document needs to be improved.
+
+* Translate from Chinese document
+
+:::

docs/100-miscellaneous/99-contributing.md

@@ -0,0 +1 @@
+label: "Miscellaneous"

docs/100-miscellaneous/_category_.yaml

@@ -0,0 +1 @@
+label: "Concepts"

docs/99-concepts/_category_.json

@@ -50,5 +50,9 @@
   "sidebar.tutorialSidebar.category.Move Specification Language and Move Prover": {
     "message": "Move 规范语言和 Move Prover",
     "description": "The label for category Move Specification Language and Move Prover in sidebar tutorialSidebar"
+  },
+  "sidebar.tutorialSidebar.category.Miscellaneous": {
+    "message": "杂项",
+    "description": "The label for category Miscellaneous in sidebar tutorialSidebar"
   }
 }

docs/99-concepts/_category_.yaml

@@ -0,0 +1,75 @@
+# 贡献指南
+
+### 环境准备
+
+1. 为了改进 Starcoin Cookbook, 首先 clone 文档的源码。
+
+```bash
+git clone https://github.com/starcoinorg/starcoin-cookbook.git
+cd starcoin-cookbook
+```
+
+2. 安装
+
+你的机器上需要预先安装好 nodejs 以及 yarn，安装方式请参看 [yarnpkg](https://yarnpkg.com/getting-started/install)。 
+
+然后在项目目录下运行：
+
+```bash
+$ yarn
+```
+
+3. 本地热加载开发
+
+在项目目录下运行一下命令，
+
+```bash
+$ yarn start
+```
+
+命令将自动打开浏览器并跳转到文档首页，你编写或者修改文档时浏览器会自动刷新。
+
+4. 完整构建文档并浏览
+
+运行以下命令进行完整构建，它同时会构建出多个语言的完整文档
+
+```bash
+$ yarn build
+```
+
+运行以下命令，将在本地启动一个 Web 服务。
+
+```bash
+$ yarn serve 
+```
+
+在浏览器中打开地址 'http://localhost:3000/starcoin-cookbook/' ，就可以看到完整的文档。
+
+5. 提交 Pull Request
+
+将自己的修改通过 Pull Request 提交到仓库（注意：你可能需要先 fork 仓库到自己的账号下，所以上面 clone 的地址也需要变更一下）。
+
+Github action 会自动触发构建任务，检查文档。等文档被 Review 并合并到主分支后，文档会被自动部署并发布。
+
+
+### 文档规范
+
+1. 文档的目录名和文件名前面都有个数字前缀，比如 `01-build.md`，用来表示文档在左侧菜单中的顺序。
+2. 文档目录以及文档名中间的多个词语用 `-` 连接。 
+3. 每个目录中的 `README.md` 表示该目录的首页。
+4. 每个目录中的 `_category_.yaml` 为该目录的配置文件，其中的 `label` 属性表示该目录在左侧菜单中展示的标题。
+5. 默认文档是英文，中文文档在 `i18n/zh/docusaurus-plugin-content-docs/current` 目录下，需要建立和英文文件同名的文件。
+
+
+
+### 常见问题
+
+1. 如何翻译目录
+
+新增目录后，运行以下命令
+
+```bash
+$ yarn write-translations --locale zh
+```
+
+你会发现文件 `i18n/zh/docusaurus-plugin-content-docs/current.json` 已经变更了，新的目录名项目已经增加，编辑该文件进行翻译即可。