en_developguide

How to contribute code to TX-LCN

Overview

TX-LCN follows Apache 2.0 Open Source Protocol. We welcome everyone to contribute code to the TX-LCN project and contribute to the open source community.

Technological process

1. (Optional) Submit the Issue to indicate the functionality you want to add or modify. We will discuss the feasibility of the modification with you and give suggestions for development.
2. (Optional) You can also identify the existing problems in the Issue list and leave a message to us in the Issue.
3. Start development, TX-LCN development process based on Github flow, see [Understanding the GitHub Flow] (https://guides.github.com/introduction/flow/)
   1. fork TX-LCN repertory(For detailed steps, please refer to Working with forks)
   2. Create new branches in your warehouse and submit code.
   3. create pull request
   4. We will review your code and give suggestions for modifications.
   5. Once the code meets the requirements, we merge the code into the main branch.
4. We will update your name to the list of TX-LCN contributors. Thank you for your contribution to TX-LCN!

Requirement

1. All TX-LCN source files need to include Apache 2.0 protocol:

   /*
    * 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. Code annotation specifications try to use English annotations, and use clear descriptive statements. Before submitting Pull Request, please use the [git rebase] (Use Git rebase) function to improve the submission record.

3. Refer to [Google Java Style Guide] (https://google.github.io/styleguide/javaguide.html) or existing source files for consistent style.

4. If you encounter problems in the development process, you can contact us through Issue at any time.