# Reproduce-Paper

**Repository Path**: luwinter/Reproduce-Paper

## Basic Information

- **Project Name**: Reproduce-Paper
- **Description**: 一个论文重现仓库  ^_^
- **Primary Language**: R
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-08-01
- **Last Updated**: 2022-07-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 论文重现（Paper Reproduction）

## 一、项目组织
1. 每篇文章的重现工作都组成一个独立的文件夹，命名为“文章作者_发表时间_期刊缩写”，例如郑志刚等于2017年发表在《中国工业经济》（China Industrial Economics）的《中国上市公司如何为独立董事制定薪酬激励合约》，命名为“Zheng_2017_CIE”

2. 文件夹内部的结构如下所示：

   ├─data/　(数据)  
   ├─material/　(论文附件资源)  
   ├─paper/　(论文原文)  
   └─scripts/　(程序脚本)  
          ├─python/  
          ├─R/  
          └─stata/  

3. 程序脚本的命名为 “首字母大写_创建时间”，如“DataClean_20210804.R”、“MainRegression_20210101.do”

   数据命名不做严格规范，但需要具有描述性，如资产负债表数据命名为“BalanceSheet.csv”， 利润表数据为“ProfitSheet.txt”，诸如此类

   数据和程序脚本的命名中**不能带有中文字符**， 如 “利润表.txt”、“data清洗.R”、“main回归.do”，诸如此类

4. 如果论文附件资源中带有数据，如“数据（公司层面）.dta”，应当先放置在material文件夹中。如果重现过程中需要使用，将其重命名（使之不带中文字符）后，放到data文件夹中

   由于gitee项目空间有限，项目本体中只存放体积较小的数据（50Mb以下）。更大的数据采用其他方式存放，如上传到云服务器后调用

5. Resources文件夹放置有用的**资源文件**，例如重要的通用程序包、CSSCI期刊列表、FT50期刊列表等等
## 二、提交规范

1. 首次使用本仓库进行开发，应当创建本地分支，并关联到远程分支

<pre name="code" class="shell">
# 首次开始工作的设置
git clone                                           ## 克隆仓库到本地
git switch -c <em>your_branch_name</em> 	                 	## 创建本地分支，也可以用git branch -b
git push --set-upstream origin <em>remote_branch_name</em>	## 将本地分支关联到远程分支
git branch -vv					         			## 检查分支状况
</pre>


2. 日常工作中，使用**分支**进行阶段性开发，在本地分支上工作，将工作同步到远程分支

   P.S. 每次**Git Push**到远程分支前，应该先对本地分支进行**Git Pull**，以确定本地分支保持在最新状态

<pre name="code" class="shell">
# 日常工作中的提交
git branch -vv     				             		## 检查分支状况，是否处于适当的本地分支下
git pull           			                 		## 拉取远程分支上的更新  
git status                      			 		## 查看分支尚未提交的修改文件  
git add <em>your_modified_file</em>			         		## 添加更改
git commit -m "<em>your message</em>"				 		## 提交更改，这里推荐结合使用Gitmoji，见附录1
git push 						 			 		## 推送更改到远程分支
</pre>


3. 阶段性工作完成后，发起**Pull Request**将分支合并到主支（master）  
   PR需要另一人**审查（Code Review）**之后方可合并到主支

4. **不要直接Git Push到主支上**

   Update：:lock: 已限制主支推送功能

5. 在Pull Request备注中简略说明阶段性工作内容

6. Git Ignore内容
   - R、Stata产生的临时性、设置性文件，如 “XXX.Rproj”
   - 对重现没有意义的内容，如 “《中国工业经济》编辑部关于公开数据附件的使用说明（2017）.pdf”


## 附录
### 1. 优化Git Commit Log —— [Gitmoji](https://gitmoji.carloscuesta.me/) 
语法：在Git Commit时，在message中加入代码块即可

```shell
git commit -m ":bug: fix an error"
```

效果图
![效果图](Resources/gitmoji_example.png)

| 效果 | 代码块 | 使用场景 |
|  ---- | ----| ----|
| :tada: | ``:tada:`` | 初次提交某文件 |
| :twisted_rightwards_arrows: | ``:twisted_rightwards_arrows:`` | 合并分支 |
| :bug: | ``:bug:`` | 修复了bug |
| :ambulance: | ``:ambulance:`` | 重要补丁 |
| :memo: | ``:memo:`` | 编写文档 |
| :zap: | ``:zap:`` | 提高代码性能 |
| :construction: | ``:construction`` | 工作进行中 |
| :fire: | ``:fire:`` | 移除代码或文件 |
| :truck: | ``:truck:`` | 移动或重命名文件 |
| :bento: | ``:bento:`` | 添加或更新资源文件 |
| :rewind: | ``:rewind:`` | 恢复更改 |