github.com/buildpacks/pack@v0.33.3-0.20240516162812-884dd1837311/CONTRIBUTING.md (about)

     1  We're glad you are interested in contributing to this project. We hope that this
     2  document helps you get started.
     3  
     4  ## Policies
     5  
     6  This repository adheres to the following project policies:
     7  
     8  - [Code of Conduct][code-of-conduct] - How we should act with each other.
     9  - [Contributing][contributing] - General contributing standards.
    10  - [Security][security] - Reporting security concerns.
    11  - [Support][support] - Getting support.
    12  
    13  ## Contributing to this repository
    14  
    15  ### Development
    16  
    17  Aside from the policies above, you may find [DEVELOPMENT.md](DEVELOPMENT.md) to provide specific helpful detail
    18  to assist you while developing in this repository.
    19  
    20  We welcome any and all contributions! The issues we are prioritizing are visible in the repository [milestones](https://github.com/buildpacks/pack/milestones), and we especially welcome contributions to that. One good place to start contributing is in our [documentation](https://github.com/buildpacks/docs/issues), though you are welcome to start in this repository!
    21  
    22  #### Preparing for a Pull Request
    23  
    24  After making all the changes but before creating a [Pull Request][pull-request-process], you should run
    25  `make prepare-for-pr`. This command runs a set of other tasks that resolve or report any simple issues that would
    26  otherwise arise during the pull request review process.
    27  
    28  ### User Acceptance on a Pull Request
    29  
    30  Running user acceptance on a pull request is just as critical as reviewing the code changes. It allows you, a contributor and user, direct insight into how a feature works and allows for you to provide feedback into what could be improved.
    31  
    32  #### Downloading PR binaries
    33  
    34  1. On GitHub's Pull Request view, click on the **Checks** tab.
    35  2. On the left panel, click on the **build** step.
    36  3. On the bottom, there is **Artifacts** section.
    37  4. Click on the zip file for the platform you are running.
    38  
    39  #### Setup
    40  
    41  1. Unzip binary:
    42      ```shell
    43      unzip pack-{{PLATFORM}}.zip
    44      ```
    45  2. Enable execution of binary _(macOS/Linux only)_:
    46      ```shell
    47      chmod +x ./pack
    48      ```
    49  
    50      > For macOS, you might need to allow your terminal to be able to execute applications from unverified developers. See [Apple Support](https://support.apple.com/en-us/HT202491).
    51      > 
    52      > A quick solution is to add exception to the downloaded pack binary: `sudo spctl --add -v ./pack`
    53  3. You should now be able to execute pack via:
    54      - macOS: `./pack`
    55      - Linux: `./pack`
    56      - Windows: `pack.exe`
    57  
    58  
    59  #### Writing Feedback
    60  
    61  When providing feedback please provide a succinct title, a summary of the observation, what you expected, and some output or screenshots.
    62  
    63  Here's a simple template you can use:
    64  
    65  ```text
    66  
    67  #### <!-- title -->
    68  
    69  <!-- a summary of what you observed -->
    70  
    71  ###### Expected
    72  
    73  <!-- describe what you expected -->
    74  
    75  ###### Output
    76  
    77  <!-- output / logs / screenshots -->
    78  ```
    79  
    80  
    81  [code-of-conduct]: https://github.com/buildpacks/.github/blob/main/CODE_OF_CONDUCT.md
    82  [contributing]: https://github.com/buildpacks/.github/blob/main/CONTRIBUTING.md
    83  [security]: https://github.com/buildpacks/.github/blob/main/SECURITY.md
    84  [support]: https://github.com/buildpacks/.github/blob/main/SUPPORT.md
    85  [pull-request-process]: https://github.com/buildpacks/.github/blob/main/CONTRIBUTIONS.md#pull-request-process