github.com/nsqio/nsq@v1.3.0/CONTRIBUTING.md (about)

     1  # Contributing
     2  
     3  Thanks for your interest in contributing to NSQ!
     4  
     5  ## Code of Conduct
     6  
     7  Help us keep NSQ open and inclusive. Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
     8  
     9  ## Getting Started
    10  
    11  * make sure you have a [GitHub account](https://github.com/signup/free)
    12  * submit a ticket for your issue, assuming one does not already exist
    13    * clearly describe the issue including steps to reproduce when it is a bug
    14    * identify specific versions of the binaries and client libraries
    15  * fork the repository on GitHub
    16  
    17  ## Making Changes
    18  
    19  * create a branch from where you want to base your work
    20    * we typically name branches according to the following format: `helpful_name_<issue_number>`
    21  * make commits of logical units
    22  * make sure your commit messages are in a clear and readable format, example:
    23    
    24  ```
    25  nsqd: fixed bug in protocol_v2
    26    
    27  * update the message pump to properly account for RDYness
    28  * cleanup variable names
    29  * ...
    30  ```
    31  
    32  * if you're fixing a bug or adding functionality it probably makes sense to write a test
    33  * make sure to run `fmt.sh` and `test.sh` in the root of the repo to ensure that your code is
    34    properly formatted and that tests pass (we use GitHub Actions for continuous integration)
    35  
    36  ## Submitting Changes
    37  
    38  * push your changes to your branch in your fork of the repository
    39  * submit a pull request against nsqio's repository
    40  * comment in the pull request when you're ready for the changes to be reviewed: `"ready for review"`