github.com/bosssauce/ponzu@v0.11.1-0.20200102001432-9bc41b703131/CONTRIBUTING.md (about)

     1  ## Contributing
     2  
     3  1. Checkout branch ponzu-dev
     4  2. Make code changes
     5  3. Test changes to ponzu-dev branch
     6      - make a commit to ponzu-dev
     7      - to manually test, you will need to use a new copy (ponzu new path/to/code), but pass the --dev flag so that ponzu generates a new copy from the ponzu-dev branch, not master by default (i.e. `$ponzu new --dev /path/to/code`)
     8      - build and run with $ ponzu build and $ ponzu run
     9  4. To add back to master: 
    10      - first push to origin ponzu-dev
    11      - create a pull request 
    12      - will then be merged into master
    13  
    14  _A typical contribution workflow might look like:_
    15  ```bash
    16  # clone the repository and checkout ponzu-dev
    17  $ git clone https://github.com/ponzu-cms/ponzu path/to/local/ponzu # (or your fork)
    18  $ git checkout ponzu-dev
    19  
    20  # install ponzu with go get or from your own local path
    21  $ go get github.com/ponzu-cms/ponzu/...
    22  # or
    23  $ cd /path/to/local/ponzu 
    24  $ go install ./...
    25  
    26  # edit files, add features, etc
    27  $ git add -A
    28  $ git commit -m 'edited files, added features, etc'
    29  
    30  # now you need to test the feature.. make a new ponzu project, but pass --dev flag
    31  $ ponzu new --dev /path/to/new/project # will create $GOPATH/src/path/to/new/project
    32  
    33  # build & run ponzu from the new project directory
    34  $ cd /path/to/new/project
    35  $ ponzu build && ponzu run
    36  
    37  # push to your origin:ponzu-dev branch and create a PR at ponzu-cms/ponzu
    38  $ git push origin ponzu-dev
    39  # ... go to https://github.com/ponzu-cms/ponzu and create a PR
    40  ```
    41  
    42  **Note:** if you intend to work on your own fork and contribute from it, you will
    43  need to also pass `--fork=path/to/your/fork` (using OS-standard filepath structure),
    44  where `path/to/your/fork` _must_ be within `$GOPATH/src`, and you are working from a branch
    45  called `ponzu-dev`. 
    46  
    47  For example: 
    48  ```bash
    49  # ($GOPATH/src is implied in the fork path, do not add it yourself)
    50  $ ponzu new --dev --fork=github.com/nilslice/ponzu /path/to/new/project
    51  ```