github.com/insionng/yougam@v0.0.0-20170714101924-2bc18d833463/libraries/go-xorm/xorm/CONTRIBUTING.md (about)

     1  ## Contributing to xorm
     2  
     3  `xorm` has a backlog of [pull requests](https://help.github.com/articles/using-pull-requests), but contributions are still very
     4  much welcome. You can help with patch review, submitting bug reports,
     5  or adding new functionality. There is no formal style guide, but
     6  please conform to the style of existing code and general Go formatting
     7  conventions when submitting patches.
     8  
     9  * [fork a repo](https://help.github.com/articles/fork-a-repo)
    10  * [creating a pull request ](https://help.github.com/articles/creating-a-pull-request)
    11  
    12  ### Language
    13  
    14  Since `xorm` is a world-wide open source project, please describe your issues or code changes in English as soon as possible.
    15  
    16  ### Sign your codes with comments
    17  ```
    18  // !<you github id>! your comments
    19  
    20  e.g.,
    21  
    22  // !lunny! this is comments made by lunny
    23  ```
    24  
    25  ### Patch review
    26  
    27  Help review existing open [pull requests](https://help.github.com/articles/using-pull-requests) by commenting on the code or
    28  proposed functionality.
    29  
    30  ### Bug reports
    31  
    32  We appreciate any bug reports, but especially ones with self-contained
    33  (doesn't depend on code outside of xorm), minimal (can't be simplified
    34  further) test cases. It's especially helpful if you can submit a pull
    35  request with just the failing test case (you'll probably want to
    36  pattern it after the tests in
    37  [base.go](https://github.com/go-xorm/tests/blob/master/base.go) AND
    38  [benchmark.go](https://github.com/go-xorm/tests/blob/master/benchmark.go).
    39  
    40  If you implements a new database interface, you maybe need to add a <databasename>_test.go file.
    41  For example, [mysql_test.go](https://github.com/go-xorm/tests/blob/master/mysql/mysql_test.go)
    42  
    43  ### New functionality
    44  
    45  There are a number of pending patches for new functionality, so
    46  additional feature patches will take a while to merge. Still, patches
    47  are generally reviewed based on usefulness and complexity in addition
    48  to time-in-queue, so if you have a knockout idea, take a shot. Feel
    49  free to open an issue discussion your proposed patch beforehand.