github.com/fnproject/cli@v0.0.0-20240508150455-e5d88bd86117/CONTRIBUTING.md (about)

     1  
     2  # Contributing to Fn CLI
     3  
     4  We welcome all contributions
     5  
     6  ## How to contribute
     7  
     8  1. Fork the repo
     9  2. Fix an issue or create an issue and fix it
    10  3. Create a Pull Request that fixes the issue
    11  4. Sign the [CLA](http://www.oracle.com/technetwork/community/oca-486395.html)
    12  5. Once processed, our CLA bot will automatically clear the CLA check on the PR
    13  6. Good Job! Thanks for being awesome!
    14  
    15  ## Advice for Forkers ##
    16  
    17  We do not advise cloning from your own fork (see [Getting the Repository](#getting-the-repository) below).
    18  
    19  Instead we suggest:
    20  1. Clone from the original repo
    21  2. Add your fork as a remote
    22  3. Push your changes to your fork
    23  4. Create your Pull Requests as normal
    24  
    25  ## Documentation
    26  
    27  When creating a Pull Request, make sure that you also update the documentation
    28  accordingly.
    29  
    30  Most of the time, when making some behavior more explicit or adding a feature,
    31  documentation update is necessary.
    32  
    33  You will either update a file inside docs/ or create one. Prefer the former over
    34  the latter. If you are unsure, do not hesitate to open a PR with a comment
    35  asking for suggestions on how to address the documentation part.
    36  
    37  ## How to build and get up and running ##
    38  
    39  ### Build Dependencies ###
    40  - [Go](https://golang.org/doc/install)
    41  - [Dep](https://github.com/golang/dep)
    42  
    43  ### Getting the Repository ###
    44  
    45  `$ git clone https://github.com/fnproject/cli.git $GOPATH/src/github.com/fnproject/cli`
    46  
    47  Note that Go will require the exact path given above in order to build (beware
    48  forkers).
    49  
    50  ### Building ###
    51  
    52  1.  Change to the correct directory (if not already there):
    53  
    54  	`$ cd $GOPATH/src/github.com/fnproject/cli`
    55  
    56  2.  Download required Go package dependencies:
    57  
    58  	`$ make dep`
    59  
    60  3.  Build and install:
    61  
    62  	`$ make install`
    63  
    64  ### Testing ###
    65  
    66  To test that your client has built correctly:
    67  
    68  `$ fn --version`
    69  
    70  It should return something like:
    71  
    72  `fn version 0.4.57`
    73  
    74  Congratulations! You're all set :-)