-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
107 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# 为 状态栏歌词 做贡献 | ||
|
||
欢迎来到 状态栏歌词 项目。继续阅读以了解有关我们的开发过程以及如何提出错误修复和改进建议的更多信息。 | ||
|
||
## Issues | ||
|
||
我们使用 GitHub Issues 来反馈问题和增加新的功能。在创建 Issues 之前,请注意以下事项: | ||
|
||
1. 请在创建 Issues 前搜索现有的 Issues 是否有重复。 | ||
2. 请确保您的描述清楚并且有足够的说明来重现问题。信息越多越好。 | ||
|
||
|
||
## 分支管理 | ||
|
||
有 2 个主要分支: | ||
|
||
1. `master` 分支 | ||
|
||
* 这是最新的(预)发布分支。我们使用 `master` 作为标签。 | ||
* **请不要在 `master` 分支上提交任何 PR。** | ||
|
||
2. `dev` 分支 | ||
|
||
* 这是用于开发和调试的分支 | ||
* 一旦 `dev` 通过内部测试,它将被合并到 `master` 分支以用于下一个版本。 | ||
* **请始终在 `dev` 分支上提交 PR。** | ||
|
||
|
||
## Pull Requests | ||
|
||
请确保在 PR 请求时完成以下操作: | ||
|
||
1. Fork 仓库并从 `master` 创建你的分支。 | ||
2. 将版权声明添加到您添加的任何新文件的顶部。 | ||
3. 请尽最大努力测试您的代码。 | ||
4. 将所有提交压缩为一个有意义的提交。 | ||
5. 每次提交只做一件事 | ||
|
||
|
||
## 代码样式 | ||
|
||
1. 4 个空格作为缩进而不是Tab作为缩进。 | ||
|
||
|
||
## License | ||
|
||
通过为 状态栏歌词 做出贡献,您同意您的贡献将根据其获得许可 [GNU General Public License v3.0](LICENSE). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Contributing to StatusBarLyric | ||
|
||
Welcome to the StatusBarLyric project. Read on to learn more about our development process and how to propose bug fixes and improvements. | ||
|
||
## Issues | ||
|
||
We use GitHub issues to track public bugs and feature requests. Before creating an issue, please note the following: | ||
|
||
1. Please search existing issues before creating a new one. | ||
2. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue. The more information the better. | ||
|
||
|
||
## Branch Management | ||
|
||
There are 2 main branches: | ||
|
||
1. `master` branch | ||
|
||
* It's the latest (pre-)release branch. We use `master` for tags. | ||
* **Please do NOT submit any PR on `master` branch.** | ||
|
||
2. `dev` branch | ||
|
||
* It's our stable developing branch. | ||
* Once `dev` has passed internal tests, it will be merged to `master` branch for the next release. | ||
* **Please always submit PR on `dev` branch.** | ||
|
||
|
||
## Pull Requests | ||
|
||
Please make sure the following is done when submitting a pull request: | ||
|
||
1. Fork the repo and create your branch from `master`. | ||
2. Add the copyright notice to the top of any new files you've added. | ||
3. Try your best to test your code. | ||
4. Squash all of your commits into one meaningful commit. | ||
5. Do only one thing per submission | ||
|
||
|
||
## Code Style Guide | ||
|
||
1. 4 spaces for indentation rather than tabs. | ||
|
||
|
||
## License | ||
|
||
By contributing to StatusBarLyric, you agree that your contributions will be licensed under its [GNU General Public License v3.0](LICENSE). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters