github.com/flower-corp/rosedb@v1.1.2-0.20230117132829-21dc4f7b319a/CONTRIBUTING.md (about)

     1  # Contribution Guide
     2  
     3  First of all, thanks for your contribution, you can participate in this project in the following ways:
     4  
     5  * create a new pull request
     6  * report a bug
     7  * create new issues
     8  * contribute documentation
     9  * give us any suggestions, such as bad code, performance, etc...
    10  
    11  ## Before you started
    12  
    13  Before you start, please make sure to read and observe our [Code Of Conduct](https://github.com/roseduan/rosedb/blob/main/CODE_OF_CONDUCT.md).
    14  
    15  ## Contribution steps
    16  
    17  * Fork the project to your own github.
    18  
    19  * Clone the project to local.
    20  * Add code and corresponding test file.
    21  * Push code and create a pull request.
    22  
    23  ## Attention
    24  
    25  Your code should comply with the following principles：
    26  
    27  * All code should be tested in your local environment, try to avoid bugs.
    28  
    29  * All public methods should have the corresponding test method.
    30  
    31  - All code should have gone through `go fmt`
    32  - All code should pass `go vet`
    33