docs: 修改 RERADME 和 CONTRIBUTING.md
This commit is contained in:
parent
adf65ac3d8
commit
c4778fbfa9
107
CONTRIBUTING.md
107
CONTRIBUTING.md
|
|
@ -37,11 +37,114 @@ The project directory structure is classified in detail as follows:
|
|||
- `widgetframe`: 和无边框界面标题栏相关的代码。/ Code related to the borderless dialog title bar.
|
||||
- `theme`: 软件主题文件，里面每个文件夹以主题名命名（必须英文）。/ Software theme files, each folder in it is named with the theme name (must be in English).
|
||||
|
||||
### 递交注释格式 / Commit Message Format
|
||||
|
||||
每条提交消息都由**标题（header）**、**正文（body）**和**页脚（footer）**组成。标题具有特殊格式，其中包括**类型（type）**、**范围（scope）**和**主题（subject）**：
|
||||
|
||||
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**:
|
||||
|
||||
```bash
|
||||
<type>(<scope>): <subject>
|
||||
<BLANK LINE>
|
||||
<body>
|
||||
<BLANK LINE>
|
||||
<footer>
|
||||
```
|
||||
|
||||
**标题（header）** 是强制性的，而 **范围（scope）** 是可选的。
|
||||
|
||||
The **header** is mandatory and the **scope** of the header is optional.
|
||||
|
||||
提交消息的任何一行都不能超过 100 个字符！这使得消息在 GitHub 以及各种 git 工具中更容易阅读。
|
||||
|
||||
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
|
||||
to read on GitHub as well as in various git tools.
|
||||
|
||||
如果 **正文（body）** 存在， **空行（BLANK LINE）** 是必须的。
|
||||
|
||||
If **body** is present, **BLANK LINE** is required.
|
||||
|
||||
如果有的话，页脚（footer）应包含 [将拉取请求链接到议题](https://help.github.com/articles/closing-issues-via-commit-messages/)。
|
||||
|
||||
The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.
|
||||
|
||||
举个例子：
|
||||
|
||||
Samples:
|
||||
|
||||
```bash
|
||||
docs(changelog): update changelog to beta.5
|
||||
```
|
||||
|
||||
```bash
|
||||
fix(release): need to depend on latest qt5
|
||||
|
||||
The version in our package.json gets copied to the one we publish, and users need the latest of these.
|
||||
```
|
||||
|
||||
### 回退分支 / Revert
|
||||
|
||||
如果提交撤销了之前的提交，则它应该以`revert:`开头，后跟撤销的提交的标题。在正文中，它应该写着：`这将撤销提交 <hash>`，其中哈希是被撤销的提交的 SHA。
|
||||
|
||||
If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>`, where the hash is the SHA of the commit being reverted.
|
||||
|
||||
### 类型 / Type
|
||||
|
||||
必须是下列之一：
|
||||
|
||||
Must be one of the following:
|
||||
|
||||
- **build**: 影响构建系统或外部依赖项的更改 / Changes that affect the build system or external dependencies
|
||||
- **ci**: 更改 CI 配置文件和脚本 / Changes to our CI configuration files and scripts
|
||||
- **docs**: 仅文档更改
|
||||
- **feat**: 新功能 / A new feature
|
||||
- **fix**: 缺陷修复 / A bug fix
|
||||
- **perf**: 修改代码得到性能提升 / A code change that improves performance
|
||||
- **refactor**: 代码更改既没有修复错误也没有添加功能 / A code change that neither fixes a bug nor adds a feature
|
||||
- **style**: 不影响代码含义的更改（空格、格式、缺少分号等） / Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
|
||||
- **test**: 添加缺失的测试或更正现有的测试 / Adding missing tests or correcting existing tests
|
||||
|
||||
### 范围 / Scope
|
||||
|
||||
范围是可选的，它通常会更加详细的指示了影响的范围，可以是分支名，也可以是版本号（比如 v1.0.0），也可以是如下几种类型：
|
||||
|
||||
The scope is optional. It usually indicates the scope of impact in more detail. It can be a branch name, a version number(e.g. v1.0.0), or the following types:
|
||||
|
||||
- **changelog**: 用于更新 CHANGELOG.md 中的发布说明 / used for updating the release notes in CHANGELOG.md
|
||||
- **readme**: 用于更新 README 中的内容 / used for updating the contents of README
|
||||
- **license**: 用于更新 LICENSE 中的内容 / used for updating the contents of LICENSE
|
||||
|
||||
### 主题 / Subject
|
||||
|
||||
主题包含对变更的简洁描述。
|
||||
|
||||
The subject contains a succinct description of the change.
|
||||
|
||||
### 正文 / Body
|
||||
|
||||
正文应该包括改变的目的并将其与之前的行为进行对比。如果在一次提交中有多种类型的修改内容，也可以按照标题的形式写到 **正文（body）** 里面。
|
||||
|
||||
The body should include the motivation for the change and contrast this with previous behavior. If there are multiple types of changes in a commit, they can also be written in the **body** in the form of titles.
|
||||
|
||||
### 脚注 / Footer
|
||||
|
||||
页脚应包含有关**重大变更**的任何信息，也是引用此提交**关闭**的 GitHub 问题的地方。
|
||||
|
||||
The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit **Closes**.
|
||||
|
||||
**重大变更** 应以单词 `BREAKING CHANGE:` 开头，中间有一个空格或两个换行符。提交消息的其余部分将用于此目的。
|
||||
|
||||
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
|
||||
|
||||
## 注意事项 / Cautions
|
||||
|
||||
您提供的代码将会遵守`AGPL-3.0`协议，第三方库将会遵守作者的开源协议。开源虽无国界，但您提供的代码来源请一定确保可靠性，不违反法律法规，不包含政治相关内容，不包含侵犯其他人或公司合法权益的代码。否则开源就是个笑话。
|
||||
您提供的代码将会遵守`AGPL-3.0`协议，第三方库将会遵守作者的开源协议。开源虽无国界，但您提供的代码来源请一定确保可靠性，不违反法律法规，不包含政治相关内容，不包含侵犯其他人或公司合法权益的代码。否则开源就是个笑话。**当你向仓库提交任何形式的代码，默认表示同意以上声明，且自愿承担因为自己的代码提交的一切责任。**
|
||||
|
||||
The code you provide will comply with the `AGPL-3.0` agreement, and the third-party library will comply with the author's open source agreement. Although open source has no borders, please ensure that the source of the code you provide is reliable, does not violate laws and regulations, does not contain political content, and does not contain code that infringes on the legal rights of other people or companies. Otherwise, open source is a joke.
|
||||
The code you provide will comply with the `AGPL-3.0` agreement, and the third-party library will comply with the author's open source agreement. Although open source has no borders, please ensure that the source of the code you provide is reliable, does not violate laws and regulations, does not contain political content, and does not contain code that infringes on the legal rights of other people or companies. Otherwise, open source is a joke. **When you submit any form of code to the repository, it means that you agree to the above statement and voluntarily assume all responsibilities for your code submission.**
|
||||
|
||||
所有的 PR 合并都需要通过 CI 检查，请注意你的**代码格式化规范**和代码提交说明是否遵循**最基础的约定式提交标准**。
|
||||
|
||||
All PR merges need to pass CI checks. Please pay attention to whether your **code formatting specifications** and code submission instructions follow the **most basic conventional submission standards**.
|
||||
|
||||
最后，再次感谢您对开源的支持和帮助。
|
||||
|
||||
|
|
|
|||
27
README.md
27
README.md
|
|
@ -5,7 +5,6 @@
|
|||
- [参与贡献](#参与贡献)
|
||||
- [软件编译运行情况](#软件编译运行情况)
|
||||
- [WingHexExplorer2](#winghexexplorer2)
|
||||
- [参与贡献](#参与贡献-1)
|
||||
- [协议](#协议)
|
||||
- [使用声明](#使用声明)
|
||||
- [issue 前必读](#issue-前必读)
|
||||
|
|
@ -84,6 +83,18 @@
|
|||
|
||||
## 参与贡献
|
||||
|
||||
- 如果您有想参与本软件代码开发递交，请在 pull request 联系我。
|
||||
- 本项目支持捐助，如有意愿请到本仓库通过微信或者支付宝的方式进行，一瓶水的价钱足以提高我的维护该项目的热情，感谢大家的支持。
|
||||
- 如果您想提交修复或者增进程序的代码，请在 pull request 递交。
|
||||
- 任何成功参与代码 Bug 修复以及增进程序功能的同志和 Sponsor ，都会在本仓库 ReadMe 和附属说明文件中体现，您如果是其中之一，本人可以按照您合理的意愿来进行说明。
|
||||
|
||||
\> **加入我们并不意味着就是代码的维护，你可以选择下列一项或多项进行参与**
|
||||
|
||||
- 代码维护：实现新功能或修复 BUG ，对代码进行维护和升级。
|
||||
- 文档编辑：主要是接口文档和教程需要撰写编辑，这很重要。
|
||||
- 参与讨论：主要是讨论本项目未来发展和方向等。
|
||||
- 编写插件：一起增强该软件的功能。
|
||||
|
||||
  在参与贡献前，请仔细阅读 [CONTRIBUTING.md](CONTRIBUTING.md)。
|
||||
|
||||
  确保在贡献和参与讨论时遵循 [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)。
|
||||
|
|
@ -110,20 +121,6 @@
|
|||
|
||||
  如果你发现该项目的功能并没有满足你的需求。请看看`TODO.txt`里面有没有说明。如果没有，可以通过`issue`进行提出。我会评估提出的需求是共性的。如果是特别私有的需求，我将不会实现。如果你实在想加入，请自行实现插件，也欢迎来开源。提建议的时候不要天马行空，注意本软件只提供最基本的十六进制编辑和浏览服务，比如 010 Editor 里面的模版和脚本等服务，还需大家一起通过插件来实现！希望大家不要只提需求，更要提出建设性建议和解决方案，共同维护开源社区。具体详情将会在后面进行介绍。
|
||||
|
||||
### 参与贡献
|
||||
|
||||
- 如果您有想参与本软件代码开发递交，请在 pull request 联系我。
|
||||
- 本项目支持捐助，如有意愿请到本仓库通过微信或者支付宝的方式进行，一瓶水的价钱足以提高我的维护该项目的热情，感谢大家的支持。
|
||||
- 如果您想提交修复或者增进程序的代码，请在 pull request 递交。
|
||||
- 任何成功参与代码 Bug 修复以及增进程序功能的同志和 Sponsor ，都会在本仓库 ReadMe 和附属说明文件中体现，您如果是其中之一，本人可以按照您合理的意愿来进行说明。
|
||||
|
||||
\> **加入我们并不意味着就是代码的维护，你可以选择下列一项或多项进行参与**
|
||||
|
||||
- 代码维护：实现新功能或修复 BUG ，对代码进行维护和升级。
|
||||
- 文档编辑：主要是接口文档和教程需要撰写编辑，这很重要。
|
||||
- 参与讨论：主要是讨论本项目未来发展和方向等。
|
||||
- 编写插件：一起增强该软件的功能。
|
||||
|
||||
### 协议
|
||||
|
||||
  本软件遵循`AGPL-3.0`协议，请勿用于该协议之外的用途。我的初衷是让 Linux 的生态更加完整，早日让祖国推动操作系统国产化，软件跨平台只是顺带。我不希望“吸血鬼”们利益归自己，脏活累活给开源，都那么理所当然，开源就是这么被败坏的。我不希望因为版权的事情牵扯了大量的精力。
|
||||
|
|
|
|||
27
README_en.md
27
README_en.md
|
|
@ -5,7 +5,6 @@
|
|||
- [Contributing](#contributing)
|
||||
- [Status](#status)
|
||||
- [WingHexExplorer2](#winghexexplorer2)
|
||||
- [Contribution](#contribution)
|
||||
- [License](#license)
|
||||
- [Usage Statement](#usage-statement)
|
||||
- [Issue](#issue)
|
||||
|
|
@ -84,6 +83,18 @@ Thanks to the sponsorship of the following people, I will try my best to continu
|
|||
|
||||
## Contributing
|
||||
|
||||
- If you want to participate in the development of this software code, please contact me in the pull request.
|
||||
- This project supports donations. If you are willing, please go to this repository through WeChat or Alipay. If you don't have any of these, you can use Afadian that supports Paypal. The price of a bottle of water is enough to increase my enthusiasm for maintaining the project. Thank you for your support.
|
||||
- If you want to submit code to fix or improve the program, please submit it in the pull request.
|
||||
- Any comrades and sponsors who successfully participate in code bug fixes and improve program functions will be reflected in the ReadMe and attached documentation of this repository. If you are one of them, I can explain it according to your reasonable wishes.
|
||||
|
||||
\> **Joining us does not mean code maintenance, you can choose one or more of the following to participate**
|
||||
|
||||
- Code maintenance: implement new features or fix bugs, maintain and upgrade the code.
|
||||
- Document editing: mainly interface documents and tutorials need to be written and edited, which is very important.
|
||||
- Participate in discussions: mainly discuss the future development and direction of this project.
|
||||
- Write plug-ins: work together to enhance the functionality of the software.
|
||||
|
||||
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for getting started with the contribution.
|
||||
|
||||
Make sure that you follow [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) while contributing and engaging in the discussions.
|
||||
|
|
@ -108,20 +119,6 @@ The ultimate goal of this project is to create a powerful, lightweight, and cros
|
|||
|
||||
If you find that the functions of this project do not meet your needs. Please check if there is any description in `TODO.txt`. If not, you can raise it through `issue`. I will evaluate whether the requirements raised are common. If it is a particularly private requirement, I will not implement it. If you really want to join, please implement the plug-in yourself, and you are also welcome to open source. Don't be fanciful when making suggestions. Please note that this software only provides the most basic hexadecimal editing and browsing services, such as templates and scripts in 010 Editor, which still need everyone to work together through plugins to achieve! I hope that everyone will not only raise requirements, but also put forward constructive suggestions and solutions to jointly maintain the open source community. Specific details will be introduced later.
|
||||
|
||||
### Contribution
|
||||
|
||||
- If you want to participate in the development of this software code, please contact me in the pull request.
|
||||
- This project supports donations. If you are willing, please go to this repository through WeChat or Alipay. If you don't have any of these, you can use Afadian that supports Paypal. The price of a bottle of water is enough to increase my enthusiasm for maintaining the project. Thank you for your support.
|
||||
- If you want to submit code to fix or improve the program, please submit it in the pull request.
|
||||
- Any comrades and sponsors who successfully participate in code bug fixes and improve program functions will be reflected in the ReadMe and attached documentation of this repository. If you are one of them, I can explain it according to your reasonable wishes.
|
||||
|
||||
\> **Joining us does not mean code maintenance, you can choose one or more of the following to participate**
|
||||
|
||||
- Code maintenance: implement new features or fix bugs, maintain and upgrade the code.
|
||||
- Document editing: mainly interface documents and tutorials need to be written and edited, which is very important.
|
||||
- Participate in discussions: mainly discuss the future development and direction of this project.
|
||||
- Write plug-ins: work together to enhance the functionality of the software.
|
||||
|
||||
### License
|
||||
|
||||
This software complies with the `AGPL-3.0` agreement. Please do not use it for purposes other than this agreement. My original intention was to make the Linux ecosystem more complete and to promote the localization of the operating system as soon as possible. Cross-platform software is just a by-product. I don't want the "vampires" to take the profits for themselves and do the dirty work for open source. It's all so natural. This is how open source is corrupted. I don't want to be involved in a lot of energy because of copyright issues.
|
||||
|
|
|
|||
Loading…
Reference in New Issue