github.com/kubeshop/testkube@v1.17.23/contrib/executor/init/CONTRIBUTING.md (about)

     1  # Contribution to Testkube 
     2  
     3  Thanks for reaching out contribution 🎉
     4  
     5  If you're new in Open-source community there is nice guide how to start contributing to projects: 
     6  https://github.com/firstcontributions/first-contributions
     7  
     8  ## Code of Conduct
     9  
    10  This project and everyone participating in it is governed by the Testkube [code of conduct](CODE_OF_CONDUCT.md)
    11  
    12  ## Have questions or idea? 
    13  
    14  We're using github discussions for managing pre-development ideas and clarifications, feel free to add one at our [Q&A discussion page](https://github.com/kubeshop/testkube/discussions/categories/q-a)
    15  
    16  New ideas should be placed in [Ideas discussion page](https://github.com/kubeshop/testkube/discussions/categories/ideas)
    17  
    18  
    19  
    20  ## General guidance for contributing to Testkube project
    21  
    22  You're very welcome to help in testkube development, there is a lot of incoming work to do :). 
    23  
    24  We're trying hard to limit technical debt from the beginning so we defined simple rules into Testkube repo to help with it.
    25  
    26  ### For golang based components
    27  
    28  - Always use gofmt (there is only one true way of doing code formatting ;) ).
    29  - Follow golang good practices (proverbs) in your code.
    30  - Tests are your friend (we will target 80% CC in our code).
    31  - Use clean names, don't brake basic design patterns and rules.
    32  
    33  ### For infrastructure / Kubernetes based components
    34  
    35  - We're using helm charts to build and share Testkube
    36  - Comment non-obvious decisions
    37  - Use current Helm/Kubernetes versions
    38  
    39  
    40  ## How can I help?
    41  
    42  - By fixing [one of many Issues](https://github.com/kubeshop/testkube/issues) - simply fork our repo and create new Pull Request with new code changes. 
    43  - By helping to reach out valid results [from discussions](https://github.com/kubeshop/testkube/discussions)
    44