# 为 LuaPanda 做出贡献

欢迎提出问题或提交代码， 建议您在为 LuaPanda 做出贡献前先阅读以下指南。 

## Issues

Issues 可以发起 bug 或者功能的讨论，我们通过 Issues 来收集问题和功能相关需求。

### 首先查看已知的问题

在您准备提出问题以前，请先查看现有的 Issues 是否已有其他人提出过相似的功能或问题，以确保您提出的问题是有效的。

### 提交问题或是发起讨论

问题的表述应当尽可能的详细，可以包含相关的代码块。

## Pull Requests

我们期待您通过 Pull Request 让项目更加完善。

### 分支管理

仓库一共包含两个分支:

1. `master` 分支

  + 请勿在master分支上提交任何PR

2. `dev` 分支

  + `dev`分支作为开发分支，经过测试后会在下一个版本合并到`master`分支。

  + PR应该在`dev`分支上提交。

### 提交代码

为保证提交的代码便于review ,提交代码请遵循以下规范:

1. 格式规范：
   + 代码缩进请使用4个空格。
   + 换行符使用LF。
   + 新增文件末加一个换行符。
   + 文件编码使用 UTF-8 (no BOM)

2. typescript代码规范

   + typescript 文件更新完成后请使用 `格式化文件(shift + alt + f)`  自动格式化代码。

3. lua 代码规范

   + 行尾使用`;`。
   + 后续计划会推出lua代码格式化功能，实现 lua 自动格式化。