github.com/milvus-io/milvus-sdk-go/v2@v2.4.1/CONTRIBUTING.md (about)

     1  # Contributing to Milvus Go SDK
     2  
     3  Contributions of all kinds and from everyone are welcome. Simply file an issue stating your reason and plans for making the change, update CHANGELOG.md, and create a pull request to the current active branch. Make sure to mention the issue you filed in your PR description. Cheers!
     4  
     5  
     6  ## What contributions can I make?
     7  
     8  Any contributions are allowed without changing the project architecture and interfaces here.
     9  You are more than welcome to make contributions.
    10  
    11  
    12  ## How can I contribute?
    13  
    14  ### Development environment
    15  
    16  You are recommended to develop using [Go](https://golang.org/dl/). We recommended using version 1.15 in this project.
    17  
    18  
    19  ### Coding Style
    20  
    21  Please follow the [Milvus Contribution Guide](https://github.com/milvus-io/milvus/blob/master/CONTRIBUTING.md#coding-style).
    22  
    23  
    24  ## Run unit test with code coverage
    25  
    26  Before submitting your PR, make sure you have the run unit test, and your code coverage rate is >= 80%.
    27  
    28  ```shell 
    29  $ ./scripts/run_go_unittest.sh
    30  ```
    31  
    32  You may need a Milvus server which is running when you run unit test. See more details on [Milvus server](https://github.com/milvus-io/milvus).
    33  
    34  
    35  ## Update CHANGLOG.md
    36  
    37  Add issue tips into CHANGLOG.md, make sure all issue tips are sorted by issue number in ascending order.