docs: change to conventionally named (#5082)

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible 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.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+os@b3log.org.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

.github/CONTRIBUTING.md

@@ -0,0 +1,53 @@
+[中文](CONTRIBUTING_zh_CN.md)
+
+## Get the source code
+
+* `git clone --recurse-submodules git@github.com:siyuan-note/siyuan.git` For example saved in `D:/siyuan/`
+* switch to dev branch
+
+## User Interface
+
+Install pnpm
+
+`npm install -g pnpm`
+
+<details>
+<summary>For China mainland</summary>
+Set the Electron mirror environment variable:
+
+* macOS/Linux: ELECTRON_MIRROR="https://cnpmjs.org/mirrors/electron/" pnpm install electron@14.2.5 -D
+* Windows: `SET ELECTRON_MIRROR=https://cnpmjs.org/mirrors/electron/`
+
+NPM mirror:
+
+* Use mirror repository `pnpm --registry https://r.cnpmjs.org/ i`
+* Revert to using official repository `pnpm --registry https://registry.npmjs.org i`
+</details>
+
+On the desktop, go to the app folder to compile and run:
+
+* `pnpm run dev`
+* `pnpm run start`
+
+## Kernel
+
+### Desktop
+
+* `cd kernel`
+* `go build --tags "fts5" -o "../app/kernel/SiYuan-Kernel.exe"`
+* `cd ../app/kernel`
+* `./SiYuan-Kernel.exe --wd=.. --mode=dev`
+
+### iOS
+
+* `cd kernel`
+* `gomobile bind --tags fts5 -ldflags '-s -w' -v -o ./ios/iosk.xcframework -target=ios ./mobile/`
+* https://github.com/siyuan-note/siyuan-ios
+
+### Android
+
+* `cd kernel`
+* `gomobile bind --tags fts5 -ldflags '-s -w' -v -o kernel.aar -target='android/arm,android/arm64' ./mobile/`
+* https://github.com/siyuan-note/siyuan-android
+
+For the mobile-end, please refer to the corresponding project repository.

.github/CONTRIBUTING_zh_CN.md

@@ -0,0 +1,50 @@
+[English](CONTRIBUTING.md)
+
+## 获取源码
+
+* `git clone --recurse-submodules git@github.com:siyuan-note/siyuan.git` 例如保存在 `D:/siyuan/`
+* 切换到 dev 分支
+
+## NPM 依赖
+
+安装 pnpm
+
+`npm install -g pnpm`
+
+<details>
+<summary>适用于中国大陆</summary>
+设置 Electron 镜像环境变量：
+
+* macOS/Linux：ELECTRON_MIRROR="https://cnpmjs.org/mirrors/electron/" pnpm install electron@14.2.5 -D
+* Windows: `SET ELECTRON_MIRROR=https://cnpmjs.org/mirrors/electron/`
+
+NPM 镜像：
+
+* 使用镜像仓库 `pnpm --registry https://r.cnpmjs.org/ i`
+* 恢复使用官方仓库 `pnpm --registry https://registry.npmjs.org i`
+</details>
+
+桌面端进入 app 文件夹编译和运行：
+
+* `pnpm run dev`
+* `pnpm run start`
+## 内核
+
+### 桌面端
+
+* `cd kernel`
+* `go build --tags "fts5" -o "../app/kernel/SiYuan-Kernel.exe"`
+* `cd ../app/kernel`
+* `./SiYuan-Kernel.exe --wd=.. --mode=dev`
+
+### iOS
+
+* `gomobile bind --tags fts5 -ldflags '-s -w' -v -o ./ios/iosk.xcframework -target=ios ./kernel/mobile/`
+* https://github.com/siyuan-note/siyuan-ios
+
+### Android
+
+* `gomobile bind --tags fts5 -ldflags '-s -w' -v -o kernel.aar -target='android/arm,android/arm64' ./kernel/mobile/`
+* https://github.com/siyuan-note/siyuan-android
+
+移动端请参考对应项目仓库。

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+open_collective: b3log
+custom: https://ld246.com/sponsor