github.com/gopinath-langote/1build@v1.7.0/CONTRIBUTING.md (about)

     1  # Contribution guidelines
     2  
     3  First of all: Thank you! We really appreciate your efforts to make 1build better ❤️
     4  
     5  Create or find an issue you would like to implement:
     6  -   issues with the label `help wanted` are ready to be picked up and implemented
     7  -   review the existing issues and ensure that you are not going to create a duplicate
     8  -   create your issue and wait for comments from maintainers
     9  -   once the issue is discussed and assigned to you – feel free to implement
    10  
    11  ## Developing 1build
    12  
    13  1.  Prepare project (Install GoLang 1.9.x)
    14  
    15      ```sh
    16      git clone https://github.com/gopinath-langote/1build
    17      cd 1build
    18      
    19      go build 
    20      ```
    21  
    22  2.  Make sure that all the existing tests are passed, extend tests if needed
    23      ```sh
    24      go test -v -cover github.com/gopinath-langote/1build/testing -run . 
    25      ```
    26      
    27      -   Alternatively `install` 1build from releases to get `1build` configuration for this project
    28  
    29  3.  Project uses major library to build app - [cobra](https://github.com/spf13/cobra)
    30  
    31  4.  Project uses - [go modules](https://github.com/golang/go/wiki/Modules) for dependency management.
    32  
    33  5.  Update necessary documents if needed – Readme etc.
    34  
    35  6.  Submit pull request
    36  
    37  7.  Make sure all the checks are passing
    38  
    39  8.  Wait for maintainers to review the code
    40  
    41  9.  Thanks for you contribution :smile:
    42  
    43  # 1build Version Release
    44  
    45  1. Install [goreleaser](https://github.com/goreleaser/goreleaser)
    46  
    47  2. Create & push git tag (version higher that already released version tag)
    48      Example:
    49      
    50     ```shell script
    51     git tag v1.5.7
    52     git push origin --tags
    53      ```
    54  
    55  3. On 1build project directory run: `goreleaser`
    56      > This will automatically create changelog on release page.
    57