github.com/thriqon/involucro@v1.1.3/CONTRIBUTING.md (about)

     1  # Contributing
     2  
     3  Involucro welcomes new development!
     4  This document briefly describes how to contribute to the [ivolucro project](https://github.com/involucro/involucro).
     5  
     6  ## Before you Begin
     7  
     8  If you have an idea for a feature to add or an approach for a bugfix,
     9  it is best to communicate with us early on. The most common venues for this are
    10  [GitHub issues](https://github.com/involucro/involucro/issues).
    11  Browse through existing GitHub issues and if one seems related,
    12  comment on it. We are generally available via [gitter](https://gitter.im/involucro/involucro).
    13  
    14  ## Reporting a new issue
    15  
    16  If no existing involucro issue seems appropriate, a new issue can be
    17  opened using [this form](https://github.com/involucro/involucro/issues/new).
    18  
    19  ## How to Contribute
    20  
    21  * All changes to the [involucro](https://github.com/involucro/involucro)
    22    should be made through pull requests to this repository (with just two
    23    exceptions outlined below).
    24  
    25  * If you are new to Git, the [Try Git](http://try.github.com/) tutorial is a good places to start.
    26    More learning resources are listed at https://help.github.com/articles/good-resources-for-learning-git-and-github/ .
    27  
    28  * Make sure you have a free [GitHub](https://github.com/) account.
    29  
    30  * Fork the [involucro repository](https://github.com/involucro/involucro) on
    31    GitHub to make your changes.
    32    To keep your copy up to date with respect to the main repository, you need to
    33    frequently [sync your fork](https://help.github.com/articles/syncing-a-fork/):
    34    ```
    35      $ git remote add upstream https://github.com/involucro/involucro
    36      $ git fetch upstream
    37      $ git checkout dev
    38      $ git merge upstream/dev
    39    ```
    40  
    41  * Additions of new features to the code base should be pushed to the `master` branch (`git
    42    checkout master`).
    43  
    44  * If your changes modify code - please ensure the resulting files
    45    conform to the Go [guidelines](https://gobyexample.com/).
    46  
    47  * Commit and push your changes to your
    48    [fork](https://help.github.com/articles/pushing-to-a-remote/).
    49  
    50  * Open a [pull
    51    request](https://help.github.com/articles/creating-a-pull-request/)
    52    with these changes. You pull request message ideally should include:
    53  
    54     * A description of why the changes should be made.
    55  
    56     * A description of the implementation of the changes.
    57  
    58     * A description of how to test the changes.
    59  
    60  * The pull request should pass all the continuous integration tests which are
    61    automatically run by GitHub using e.g. Travis CI.
    62  
    63  * After reviewing your pull request and optional discussions we will merge it into the main branch.