tinygo.org/x/drivers@v0.27.1-0.20240509133757-7dbca2a54349/CONTRIBUTING.md (about)

     1  # How to contribute
     2  
     3  Thank you for your interest in improving the TinyGo drivers.
     4  
     5  We would like your help to make this project better, so we appreciate any contributions. See if one of the following descriptions matches your situation:
     6  
     7  ### New to TinyGo
     8  
     9  We'd love to get your feedback on getting started with TinyGo. Run into any difficulty, confusion, or anything else? You are not alone. We want to know about your experience, so we can help the next people. Please open a Github issue with your questions, or you can also get in touch directly with us on our Slack channel at [https://gophers.slack.com/messages/CDJD3SUP6](https://gophers.slack.com/messages/CDJD3SUP6).
    10  
    11  ### One of the TinyGo drivers is not working as you expect
    12  
    13  Please open a Github issue with your problem, and we will be happy to assist.
    14  
    15  ### Some specific hardware you want to use does not appear to be in the TinyGo drivers
    16  
    17  We probably have not implemented it yet. Your contribution adding the hardware support to TinyGo would be greatly appreciated.
    18  
    19  Please first open a Github issue. We want to help, and also make sure that there is no duplications of efforts. Sometimes what you need is already being worked on by someone else.
    20  
    21  ## How to use our Github repository
    22  
    23  The `release` branch of this repo will always have the latest released version of the TinyGo drivers. All of the active development work for the next release will take place in the `dev` branch. The TinyGo drivers will use semantic versioning and will create a tag/release for each release.
    24  
    25  Here is how to contribute back some code or documentation:
    26  
    27  - Fork repo
    28  - Create a feature branch off of the `dev` branch
    29  - Make some useful change
    30  - Make sure the tests still pass
    31  - Submit a pull request against the `dev` branch.
    32  - Be kind
    33  
    34  ## How to run tests
    35  
    36  To run the tests:
    37  
    38  ```
    39  make test
    40  ```