Skip to content

Commit

Permalink
Add user acceptance contributions
Browse files Browse the repository at this point in the history
Signed-off-by: Javier Romero <[email protected]>
  • Loading branch information
jromero authored Mar 25, 2020
1 parent 0a0e924 commit dab382e
Showing 1 changed file with 56 additions and 4 deletions.
60 changes: 56 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
We're glad you are interested in contributing to this project. We hope that this
document helps you get started.

### Policies
## Policies

This repository adheres to the following project policies:

Expand All @@ -10,9 +10,9 @@ This repository adheres to the following project policies:
- [Security][security] - Reporting security concerns.
- [Support][support] - Getting support.

### Contributing to this repository
## Contributing to this repository

#### Development
### Development

Aside from the policies above, you may find [DEVELOPMENT.md](DEVELOPMENT.md) to provide specific helpful detail
to assist you while developing in this repository.
Expand All @@ -21,7 +21,59 @@ to assist you while developing in this repository.

After making all the changes but before creating a [Pull Request][pull-request-process], you should run
`make prepare-for-pr`. This command runs a set of other tasks that resolve or report any simple issues that would
otherwise arise during the pull request review process.
otherwise arise during the pull request review process.

### User Acceptance on a Pull Request

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.

#### Downloading PR binaries

1. On GitHub's Pull Request view, click on the **Checks** tab.
2. On the top-right, click **Artifacts**.
3. Click on the zip file for the platform you are running.

#### Setup

1. Unzip binary:
```shell
unzip pack-{{PLATFORM}}.zip
```
2. Enable execution of binary _(macOS/Linux only)_:
```shell
chmod +x ./pack
```

> 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).
>
> A quick solution is to add exception to the downloaded pack binary: `sudo spctl --add -v ./pack`
3. You should now be able to execute pack via:
- macOS: `./pack`
- Linux: `./pack`
- Windows: `pack.exe`


#### Writing Feedback

When providing feedback please provide a succinct title, a summary of the observation, what you expected, and some output or screenshots.

Here's a simple template you can use:
```text
#### <!-- title -->
<!-- a summary of what you observed -->
###### Expected
<!-- describe what you expected -->
###### Output
<!-- output / logs / screenshots -->
```
[code-of-conduct]: https://github.com/buildpacks/.github/blob/master/CODE_OF_CONDUCT.md
[contributing]: https://github.com/buildpacks/.github/blob/master/CONTRIBUTING.md
Expand Down

0 comments on commit dab382e

Please sign in to comment.