【类 型】:docs
【主 题】:开发相关公共文档 【描 述】: [原因]: [过程]: [影响]: 【结 束】 # 类型 包含: # feat:新功能(feature) # fix:修补bug # docs:文档(documentation) # style: 格式(不影响代码运行的变动) # refactor:重构(即不是新增功能,也不是修改bug的代码变动) # test:增加测试 # chore:构建过程或辅助工具的变动
This commit is contained in:
commit
36bc2e4fcf
18
git相关/提交模板/commit_template.txt
Normal file
18
git相关/提交模板/commit_template.txt
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
【类 型】:
|
||||||
|
【主 题】:
|
||||||
|
【描 述】:
|
||||||
|
[原因]:
|
||||||
|
[过程]:
|
||||||
|
[影响]:
|
||||||
|
【结 束】
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# 类型 包含:
|
||||||
|
# feat:新功能(feature)
|
||||||
|
# fix:修补bug
|
||||||
|
# docs:文档(documentation)
|
||||||
|
# style: 格式(不影响代码运行的变动)
|
||||||
|
# refactor:重构(即不是新增功能,也不是修改bug的代码变动)
|
||||||
|
# test:增加测试
|
||||||
|
# chore:构建过程或辅助工具的变动
|
21
git相关/项目说明模板/LICENSE.txt
Normal file
21
git相关/项目说明模板/LICENSE.txt
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2018 Othneil Drew
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
179
git相关/项目说明模板/README.md
Normal file
179
git相关/项目说明模板/README.md
Normal file
@ -0,0 +1,179 @@
|
|||||||
|
|
||||||
|
|
||||||
|
# ProjectName
|
||||||
|
|
||||||
|
ProjectName and Description
|
||||||
|
|
||||||
|
<!-- PROJECT SHIELDS -->
|
||||||
|
|
||||||
|
[![Contributors][contributors-shield]][contributors-url]
|
||||||
|
[![Forks][forks-shield]][forks-url]
|
||||||
|
[![Stargazers][stars-shield]][stars-url]
|
||||||
|
[![Issues][issues-shield]][issues-url]
|
||||||
|
[![MIT License][license-shield]][license-url]
|
||||||
|
[![LinkedIn][linkedin-shield]][linkedin-url]
|
||||||
|
|
||||||
|
<!-- PROJECT LOGO -->
|
||||||
|
<br />
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://github.com/shaojintian/Best_README_template/">
|
||||||
|
<img src="images/logo.png" alt="Logo" width="80" height="80">
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<h3 align="center">"完美的"README模板</h3>
|
||||||
|
<p align="center">
|
||||||
|
一个"完美的"README模板去快速开始你的项目!
|
||||||
|
<br />
|
||||||
|
<a href="https://github.com/shaojintian/Best_README_template"><strong>探索本项目的文档 »</strong></a>
|
||||||
|
<br />
|
||||||
|
<br />
|
||||||
|
<a href="https://github.com/shaojintian/Best_README_template">查看Demo</a>
|
||||||
|
·
|
||||||
|
<a href="https://github.com/shaojintian/Best_README_template/issues">报告Bug</a>
|
||||||
|
·
|
||||||
|
<a href="https://github.com/shaojintian/Best_README_template/issues">提出新特性</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
本篇README.md面向开发者
|
||||||
|
|
||||||
|
## 目录
|
||||||
|
|
||||||
|
- [上手指南](#上手指南)
|
||||||
|
- [开发前的配置要求](#开发前的配置要求)
|
||||||
|
- [安装步骤](#安装步骤)
|
||||||
|
- [文件目录说明](#文件目录说明)
|
||||||
|
- [开发的架构](#开发的架构)
|
||||||
|
- [部署](#部署)
|
||||||
|
- [使用到的框架](#使用到的框架)
|
||||||
|
- [贡献者](#贡献者)
|
||||||
|
- [如何参与开源项目](#如何参与开源项目)
|
||||||
|
- [版本控制](#版本控制)
|
||||||
|
- [作者](#作者)
|
||||||
|
- [鸣谢](#鸣谢)
|
||||||
|
|
||||||
|
### 上手指南
|
||||||
|
|
||||||
|
请将所有链接中的“shaojintian/Best_README_template”改为“your_github_name/your_repository”
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
###### 开发前的配置要求
|
||||||
|
|
||||||
|
1. xxxxx x.x.x
|
||||||
|
2. xxxxx x.x.x
|
||||||
|
|
||||||
|
###### **安装步骤**
|
||||||
|
|
||||||
|
1. Get a free API Key at [https://example.com](https://example.com)
|
||||||
|
2. Clone the repo
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone https://github.com/shaojintian/Best_README_template.git
|
||||||
|
```
|
||||||
|
|
||||||
|
### 文件目录说明
|
||||||
|
eg:
|
||||||
|
|
||||||
|
```
|
||||||
|
filetree
|
||||||
|
├── ARCHITECTURE.md
|
||||||
|
├── LICENSE.txt
|
||||||
|
├── README.md
|
||||||
|
├── /account/
|
||||||
|
├── /bbs/
|
||||||
|
├── /docs/
|
||||||
|
│ ├── /rules/
|
||||||
|
│ │ ├── backend.txt
|
||||||
|
│ │ └── frontend.txt
|
||||||
|
├── manage.py
|
||||||
|
├── /oa/
|
||||||
|
├── /static/
|
||||||
|
├── /templates/
|
||||||
|
├── useless.md
|
||||||
|
└── /util/
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### 开发的架构
|
||||||
|
|
||||||
|
请阅读[ARCHITECTURE.md](https://github.com/shaojintian/Best_README_template/blob/master/ARCHITECTURE.md) 查阅为该项目的架构。
|
||||||
|
|
||||||
|
### 部署
|
||||||
|
|
||||||
|
暂无
|
||||||
|
|
||||||
|
### 使用到的框架
|
||||||
|
|
||||||
|
- [xxxxxxx](https://getbootstrap.com)
|
||||||
|
- [xxxxxxx](https://jquery.com)
|
||||||
|
- [xxxxxxx](https://laravel.com)
|
||||||
|
|
||||||
|
### 贡献者
|
||||||
|
|
||||||
|
请阅读**CONTRIBUTING.md** 查阅为该项目做出贡献的开发者。
|
||||||
|
|
||||||
|
#### 如何参与开源项目
|
||||||
|
|
||||||
|
贡献使开源社区成为一个学习、激励和创造的绝佳场所。你所作的任何贡献都是**非常感谢**的。
|
||||||
|
|
||||||
|
|
||||||
|
1. Fork the Project
|
||||||
|
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
|
||||||
|
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
|
||||||
|
4. Push to the Branch (`git push origin feature/AmazingFeature`)
|
||||||
|
5. Open a Pull Request
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### 版本控制
|
||||||
|
|
||||||
|
该项目使用Git进行版本管理。您可以在repository参看当前可用版本。
|
||||||
|
|
||||||
|
### 作者
|
||||||
|
|
||||||
|
xxx@xxxx
|
||||||
|
|
||||||
|
知乎:xxxx   qq:xxxxxx
|
||||||
|
|
||||||
|
*您也可以在贡献者名单中参看所有参与该项目的开发者。*
|
||||||
|
|
||||||
|
### 版权说明
|
||||||
|
|
||||||
|
该项目签署了MIT 授权许可,详情请参阅 [LICENSE.txt](https://github.com/shaojintian/Best_README_template/blob/master/LICENSE.txt)
|
||||||
|
|
||||||
|
### 鸣谢
|
||||||
|
|
||||||
|
|
||||||
|
- [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
|
||||||
|
- [Img Shields](https://shields.io)
|
||||||
|
- [Choose an Open Source License](https://choosealicense.com)
|
||||||
|
- [GitHub Pages](https://pages.github.com)
|
||||||
|
- [Animate.css](https://daneden.github.io/animate.css)
|
||||||
|
- [xxxxxxxxxxxxxx](https://connoratherton.com/loaders)
|
||||||
|
|
||||||
|
<!-- links -->
|
||||||
|
[your-project-path]:shaojintian/Best_README_template
|
||||||
|
[contributors-shield]: https://img.shields.io/github/contributors/shaojintian/Best_README_template.svg?style=flat-square
|
||||||
|
[contributors-url]: https://github.com/shaojintian/Best_README_template/graphs/contributors
|
||||||
|
[forks-shield]: https://img.shields.io/github/forks/shaojintian/Best_README_template.svg?style=flat-square
|
||||||
|
[forks-url]: https://github.com/shaojintian/Best_README_template/network/members
|
||||||
|
[stars-shield]: https://img.shields.io/github/stars/shaojintian/Best_README_template.svg?style=flat-square
|
||||||
|
[stars-url]: https://github.com/shaojintian/Best_README_template/stargazers
|
||||||
|
[issues-shield]: https://img.shields.io/github/issues/shaojintian/Best_README_template.svg?style=flat-square
|
||||||
|
[issues-url]: https://img.shields.io/github/issues/shaojintian/Best_README_template.svg
|
||||||
|
[license-shield]: https://img.shields.io/github/license/shaojintian/Best_README_template.svg?style=flat-square
|
||||||
|
[license-url]: https://github.com/shaojintian/Best_README_template/blob/master/LICENSE.txt
|
||||||
|
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
|
||||||
|
[linkedin-url]: https://linkedin.com/in/shaojintian
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
BIN
git相关/项目说明模板/images/logo.png
Normal file
BIN
git相关/项目说明模板/images/logo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 2.3 KiB |
Loading…
Reference in New Issue
Block a user