en_developguide

如何向TX-LCN贡献代码

概述

TX-LCN遵循Apache 2.0开源协议，我们欢迎所有人向TX-LCN项目贡献代码，为开源社区贡献力量。

流程

1. （可选）提交Issue，说明你想要增加或修改的功能，我们会与你进行讨论修改的可行性并给出开发的建议。
2. （可选）你也可以认领Issue列表中已有的问题，在Issue中留言告知我们。
3. 开始开发，TX-LCN的开发流程基于Github flow，请参考Understanding the GitHub Flow
   1. fork TX-LCN仓库(详细步骤请参考Working with forks)
   2. 在你的仓库中创建新的分支并提交代码。
   3. 创建pull request
   4. 我们会review你的代码并给出修改的建议。
   5. 代码符合要求后，我们会将代码合并到主分支。
4. 我们会把你的名字更新到TX-LCN的贡献者列表，感谢你对TX-LCN的贡献！

要求

1. 所有TX-LCN源文件头需要包含Apache 2.0协议：

   /*
    * Copyright 2017-2019 CodingApi .
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    *      http://www.apache.org/licenses/LICENSE-2.0
    *
    * Unless required by applicable law or agreed to in writing, software
    * distributed under the License is distributed on an "AS IS" BASIS,
    * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    * See the License for the specific language governing permissions and
    * limitations under the License.
    */
   

2. 代码注释规范尽量使用英文注释，并使用清晰的描述语句，提交Pull Request前请使用[git rebase](Using Git rebase)功能完善提交记录。

3. 代码格式请参考Google Java Style Guide或已有的源文件，保持风格一致。

4. 开发过程中如果遇到问题可以随时通过Issue与我们联系。

如何更新 Wiki

对于文档性的介绍我们都在官网更新，官网docs项目在txlcn-docs，你可以提交pull request来修改这些文件，我们会将更新合并到官网页面中。