github.com/qiwihui/DBShield@v0.0.0-20171107092910-fb8553bed8ef/CONTRIBUTING.md (about)

     1  # Contributing
     2  
     3  Thank you for considering contributing! There are many ways you can help.
     4  
     5  ## Issues
     6  
     7  File an issue if you think you've found a bug. Be sure to describe
     8  
     9  1. How can it be reproduced?
    10  2. What did you expect?
    11  3. What actually occurred?
    12  4. Go version, platform, etc. if possibly relevant.
    13  
    14  ## Docs
    15  
    16  Godocs documentation, READMEs, and examples are extremely imporant. Please help improve them and if you find a typo or notice a problem, please send a fix or say something.
    17  
    18  ## Submitting Patches
    19  
    20  Patches for fixes, features, and improvements are accepted through pull requests.
    21  
    22  * Sign [CIA](https://cla-assistant.io/nim4/DBShield)
    23  * Code must be go fmt'd.
    24  * Code must pass golint and vet checks. 
    25  * Exported methods must be documented.
    26  * Include tests to improve coverage and prevent regressions.
    27  * Squash changes into a single commit per feature/fix.
    28  * Write good commit messages.
    29  
    30  Please ask before embarking on a large improvement so you're not disappointed if it does not align with the goals of the project.
    31  
    32  ## Feature Requests
    33  
    34  Make the case for a feature via an issue with a good title. The feature should be discussed and given a target inclusion milestone or closed.
    35  
    36  ## Contact
    37  
    38  If you'd like to ask about something directly, tweet at [@Nilvl4](https://twitter.com/nilvl4) or email ghotbi.nima at gmail.
    39