mirror_css/nes.css
1
0
Fork 0
mirror of https://github.com/nostalgic-css/NES.css.git synced 2025-08-19 20:41:42 +02:00
Code Issues Releases Wiki Activity

Add Chinese translations for REAME.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md

Browse Source
This commit is contained in:
kenshinji
2018-12-23 22:41:19 +08:00
parent 7eb6f33520
commit 972b0c42e7
3 changed files with 289 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
.github/CODE_OF_CONDUCT-zh-CN.md vendored Normal file
View File

@@ -0,0 +1,57 @@
# 参与者行为准则
使用其他语言来阅读本文档:
[日本語](.github/CONTRIBUTING-jp.md) / [Español](.github/CONTRIBUTING-es.md) / [Português](.github/CONTRIBUTING-pt-BR.md)
## 我们的誓言
为了维护一个开放并且友好的环境, 作为贡献者以及维护者，我们宣誓确保参与我们的项目以及社区的每一个人都有免受骚扰的体验，不管他/她的年纪，体型，残疾与否，种族，性别特征与表达，经验程度，国籍，个人外貌，种族，宗教信仰，性特征以及性取向如何。
## 我们的标准
关于创建积极的环境的贡献的例子包括:
* 使用欢迎友好以及包容的语言
* 尊重不同的视角以及经验
* 优雅的接受有建设性的批评
* 聚焦于对社区有利的方面
* 展现对应其他社区成员的认同
对于参与者来说不可接受的行为包括:
* 性语言的使用或者具象化并且不受欢迎的性诱惑或者更进一步
* 抹黑，羞辱的/贬损的评论，和针对个人或政治性的攻击
* 公开或者私下骚扰
* 公开其他人的隐私信息，比如未经许可的物理或者电子(邮箱)地址
* 在专业领域其他被认为不合时宜的行为
## 我们的义务
项目维护者们有义务澄清可以被接受的行为的标准，并且对于任何不可接受的行为应当采取合适并且正确的行动来对待。
项目维护者们有权利和义务去删除，编辑，或者拒绝评论，提交，代码，维基编辑，问题等，以及其他不符合行为准则的贡献，或者当某些贡献者被视为不合时宜的，威胁性的，冒犯的或者有害的时候，我们也可以临时性地或者永久性地封禁他们。
## 范畴
本行为准则适用于本项目空间，或者当个人代表本项目或社区在公共场合出席的场合。代表一个项目或者社区的例子包括使用一个官方的项目邮件地址，通过官方社交媒体账号发帖，或者作为一个指定的代表参与线上或者线下的活动。如何作为一个项目的代表可能会进一步被项目维护者定义并且澄清。
## 执行
你可以通过[support@nostalgi.cc][support-email]联系项目组举报辱骂，骚扰或者其他不被接受的行为事例。如果联系整个项目组是不必要的，请私下联系项目组的任何成员:
* B.C.Rikko <[b.c.rikko@gmail.com](mailto:b.c.rikko@gmail.com)>
* Igor Guastalla <[limaguastallaigor@gmail.com](mailto:limaguastallaigor@gmail.com)>
* Trezy <[tre@trezy.com](mailto:tre@trezy.com)>
所有的投诉都会被审核并且进行调查，并且会对公众出具一个视为必要且合适的回复。项目组有义务维护举报者个人的隐私。进一步的具体执行细节政策可能会分开来发布。
不真诚地遵守或者执行行为准则的项目维护者可能会面临项目领导其他成员所决定的临时的或者永久的影响。
## 归属
本行为准则改编自[贡献者契约][homepage], 版本 1.4, 可以从这里访问 [http://contributor-covenant.org/version/1/4][version]
[homepage]: http://contributor-covenant.org
[support-email]: mailto:support@nostalgi.cc
[version]: http://contributor-covenant.org/version/1/4/

102
.github/CONTRIBUTING-zh-CN.md vendored Normal file
View File

@@ -0,0 +1,102 @@
# 贡献
使用其他语言来阅读本文档:
[日本語](.github/CONTRIBUTING-jp.md) / [Español](.github/CONTRIBUTING-es.md) / [Português](.github/CONTRIBUTING-pt-BR.md)
你打算为本项目做贡献？太棒了！
## 需要知道的事情
本项目与参与者行为准则保持一致. 我们期望你在参与本项目的时候也赞同并支持该行为准则. 关于报告不可接受的行为，请参考我们的[行为准则][code-of-conduct].
**在忙于你的第一个PR吗?**
[如何在GitHub上面为开源项目做贡献][egghead]
## 如何
* 搭建项目?
[我们有详细的说明!](#project-setup)
* 找到了bug?
[请让我们知道!][new-issue]
* 为bug打补丁?
[提交PR!][new-pr]
* 添加一个新功能?
请确保[新开一个issue][new-issue] 来描述你的功能, 当你准备好接受反馈的时候再提交一个[新的PR][new-pr]!
## 搭建项目
你有想为我们的项目做贡献，我们真的很高兴! ❤️ 请参考如下的步骤开始吧:
1. Fork 并且 clone 我们的代码仓库
2. 安装必须的依赖:
```sh
$ npm install
```
3. 启动开发服务器:
```sh
$ npm run storybook
```
### 目录结构
```sh
.
├── index.html: Demo page
├── style.css: Demo page style
├── css: Distribution files
├── docs: Storybook stories
└── scss: Source
├── base
│ ├── reboot.scss: Don't change! (Bootstrap Reboot)
│ ├── generic.scss: Generic style and reboot.css
│ └── variables.scss: Common variables
├── elements
├── form
├── icons: 16x16 icons
├── pixel-arts: For icons other than 16x16.
└── utilities
```
> 小建议: 确保你的 `master` 分支指向原始的代码仓库并且从你fork的分支上创建PR. 请按如下命令进行操作:
>
> ```
> git remote add upstream https://github.com/nostalgic-css/NES.css.git
> git fetch upstream
> git branch --set-upstream-to=upstream/master master
> ```
>
> 这样就会把原始的代码仓库添加为一个名为"upstream"的远程连接,并且从这个远程的仓库连接获取git的信息, 然后当你运行`git pull`命令的时候会指定本地的`master`分支去使用`upstream/master`分支. 在这个时候, 你就能基于这个`master` 分支来创建所有你自己的分支. 当你想更新你的`master`的版本信息的时候, 执行一个常规的`git pull`命令即可.
## `nostalgic-css` 组织如何为项目做贡献
`nostalgic-css` 组织的成员必须遵守如下的步骤. 外部的贡献者只需要遵守以上的准则即可.
### 开发步骤
1. 使用下面的格式化规则从`develop`分支来创建自己的分支。
2. 做满足问题要求的必要的工作。如果发现你的工作跟该问题无关，请[创建一个新的问题][new-issue]并且在另外一个分支在进行你的工作。
3. 提交你的PR然后合并回`develop`分支.
* 任何影响当前开发的改变都必须在文档里面描述清楚.
* 跟某一问题相关的PRs必须把那个问题的号码标注在标题里. 比如: `[#33] Fix bug`
* 分配一个问题给你自己.
* 当这个问题准备合并的时候, 必须向`nostalgic-css/NES.css` 小组申请审核.
4. 一旦PR被批准了，接下来合并分支的更改就是被分配者的义务了。
### 提交格式化
我们使用[Commitizen][commitizen] 以及 [`commitlint`][commitlint] 来确保所有的项目提交都是易于阅读的, 并且使用 [`semantic-release`][semantic-release] 来确保我们的发布是自动化的, [不浪漫的以及不带情感色彩的][sentimental-versioning].
[code-of-conduct]: CODE_OF_CONDUCT.md
[commitizen]: https://github.com/commitizen/cz-cli
[commitlint]: [https://github.com/marionebl/commitlint]
[egghead]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
[new-issue]: https://github.com/nostalgic-css/NES.css/issues/new
[new-pr]: https://github.com/nostalgic-css/NES.css/compare/develop...develop
[semantic-release]: https://github.com/semantic-release/semantic-release
[sentimental-versioning]: http://sentimentalversioning.org/

130
.github/README-zh-CN.md vendored Normal file
View File

@@ -0,0 +1,130 @@
<div align="center">
<a href="https://nostalgic-css.github.io/NES.css/" target="_blank"><img src="https://user-images.githubusercontent.com/5305599/49061716-da649680-f254-11e8-9a89-d95a7407ec6a.png" alt="NES.css: NES-style CSS framework" style="max-width:100%;" width="600" height="315"></a>
<a href="README.md">English</a> / <a href="README-jp.md">日本語</a> / <a href="README-es.md">Español</a> / <a href="README-pt-BR.md">Português</a>
</div>
NES.css 是一款 **NES-风格(8位机)** 的CSS 框架.
[![Gitter][gitter-badge]][gitter] [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
## 安装
### CDN
```html
<!-- minify -->
<link href="https://unpkg.com/nes.css@0.0.2/css/nes.min.css" rel="stylesheet" />
<!-- latest -->
<link href="https://unpkg.com/nes.css/css/nes.min.css" rel="stylesheet" />
```
或者
```html
<!-- non-minified -->
<link href="https://unpkg.com/nes.css@0.0.2/css/nes.css" rel="stylesheet" />
<!-- latest -->
<link href="https://unpkg.com/nes.css/css/nes.css" rel="stylesheet" />
```
### npm
TODO: npm での使用方法を書く
## 使用
NES.css 只提供组件. 你需要定义你自己的布局.
默认字体[Press Start 2P](https://fonts.google.com/specimen/Press+Start+2P?selection.family=Press+Start+2P) 只支持英文字符. 当你把这个框架与其他非英语的语言一起使用的时候, 请使用另外的字体. 请根据这个关于Google Fonts的 [说明](https://developers.google.com/fonts/docs/getting_started) 了解如何把它引入项目, 或者按照如下方式简单引人:
```html
<head>
<link href="https://fonts.googleapis.com/css?family=Press+Start+2P" rel="stylesheet">
<link href="https://unpkg.com/nes.css/css/nes.css" rel="stylesheet" />
<style>
html, body, pre, code, kbd, samp {
font-family: "font-family you want to use";
}
</style>
</head>
```
### 推荐字体
|Language|Font|
|----|----|
|(Default)|[Press Start 2P](https://fonts.google.com/specimen/Press+Start+2P)|
|English|[Kongtext](https://www.dafont.com/kongtext.font)|
|Japanese|[美咲フォント](http://www.geocities.jp/littlimi/misaki.htm)|
|Japanese|[Nu もち](http://kokagem.sakura.ne.jp/font/mochi/)|
## 只需要CSS
NES.css 仅仅需要 CSS 而不依赖其他任何 JavaScript.
## 浏览器支持
NES.css 与如下浏览器的最新版本兼容.
* Chrome
* Firefox
* Safari
未经测试
* IE/Edge
## 开发
### 命令
```sh
git clone git@github.com:BcRikko/NES.css.git
cd NES.css
npm i
npm run watch
npm run build
```
#### 运行 Storybook
```
npm run storybook
```
在预提交阶段Linting, 格式化以及构建都会自动运行.
TODO: ビルドはCIでするように変更したい
### 目录结构
```sh
.
├── index.html: Demo page
├── style.css: Demo page style
├── css: Distribution files
├── docs: Storybook stories
└── scss: Source
├── base
│ ├── reboot.scss: Don't change! (Bootstrap Reboot)
│ ├── generic.scss: Generic style and reboot.css
│ └── variables.scss: Common variables
├── elements
├── form
├── icons: 16x16 icons
├── pixel-arts: For icons other than 16x16.
└── utilities
```
## 版权许可
代码以及文档版权 2018 [B.C.Rikko](https://github.com/BcRikko). 代码基于MIT许可发布. 文档基于Creative Commons许可发布.
[gitter]: https://gitter.im/nostalgic-css/Lobby
[gitter-badge]: https://img.shields.io/gitter/room/nostalgic-css/Lobby.svg