github.com/Ali-iotechsys/sqlboiler/v4@v4.0.0-20221208124957-6aec9a5f1f71/CONTRIBUTING.md (about)

     1  # Contributing
     2  
     3  Thanks for your interest in contributing to SQLBoiler!
     4  
     5  We have a very lightweight process and aim to keep it that way.
     6  Read the sections for the piece you're interested in and go from
     7  there.
     8  
     9  If you need quick communication we're usually on [Slack](https://sqlboiler.from-the.cloud).
    10  
    11  # New Code / Features
    12  
    13  ## Small Change
    14  
    15  #### TLDR
    16  
    17  1. Open PR against **master** branch with explanation
    18  1. Participate in Github Code Review
    19  
    20  #### Long version
    21  
    22  For code that requires little to no discussion, please just open a pull request with some
    23  explanation against the **master** branch. 
    24  
    25  ## Bigger Change
    26  
    27  #### TLDR
    28  
    29  1. Start proposal of idea in Github issue
    30  1. After design concensus, open PR with the work against the **master** branch
    31  1. Participate in Github Code Review
    32  
    33  #### Long version
    34  
    35  If however you're working on something bigger, it's usually better to check with us on the idea
    36  before starting on a pull request, just so there's no time wasted in redoing/refactoring or being
    37  outright rejected because the PR is at odds with the design. The best way to accomplish this is to
    38  open an issue to discuss it. It can always start as a Slack conversation but should eventually end
    39  up as an issue to avoid penalizing the rest of the users for not being on Slack. Once we agree on
    40  the way to do something, then open the PR against the **master** branch and we'll commence code review
    41  with the Github code review tools. Then it will be merged into master, and later go out in a release.
    42  
    43  ## Developer getting started
    44  
    45  1. Add a [Configuration files](https://github.com/volatiletech/sqlboiler#configuration).
    46  1. Write your changes
    47  1. Generate executable. Run again if you have changed anything in core code or driver code.
    48     ```
    49     ./boil.sh build all
    50     ```
    51  
    52  1. Also Move sqlboiler-[driver] built to the bin of gopath if you have changed the driver code.
    53  
    54  1. Generate your models from existing tables
    55  
    56     ```
    57     ./boil.sh gen [driver]
    58     ```
    59  
    60  1. You may need to install following package before able to run the tests.
    61  
    62     ```
    63     go get -u github.com/volatiletech/null
    64     ```
    65  
    66  1. Test the output
    67  
    68     ```
    69     ./boil.sh test
    70     ```
    71  
    72  
    73  # Bugs
    74  
    75  Issues should be filed on Github, simply use the template provided and fill in detail. If there's
    76  more information you feel you should give use your best judgement and add it in, the more the better.
    77  See the section below for information on providing database schemas.
    78  
    79  Bugs that have responses from contributors but no action from those who opened them after a time
    80  will be closed with the comment: "Stale"
    81  
    82  ## Schemas
    83  
    84  A database schema can help us fix generation issues very quickly. However not everyone is willing to part
    85  with their database schema for various reasons and that's fine. Instead of providing the schema please
    86  then provide a subset of your database (you can munge the names so as to be unrecognizable) that can
    87  help us reproduce the problem.
    88  
    89  _Note:_ Your schema information is included in the output from `--debug`, so be careful giving this
    90  information out publicly on a Github issue if you're sensitive about this.