|
| 1 | +# Contributing to BOSH-Process-Manager (BPM) |
| 2 | + |
| 3 | +The BPM team uses GitHub and accepts contributions via [pull request](https://help.github.com/articles/using-pull-requests). |
| 4 | + |
| 5 | +The `bpm-release` repository is a [BOSH](https://github.com/cloudfoundry/bosh) release for BPM. The root of this repository doubles as a Golang [`GOPATH`](https://golang.org/doc/code.html#GOPATH). |
| 6 | +For more information about configuring your Golang environment and automatically setting your `GOPATH` to the release directory. |
| 7 | + |
| 8 | +Changes are via pull request (PR) to the master branch of its repository. |
| 9 | + |
| 10 | +Please verify your changes before submitting the PR by following the [Testing](#testing) section below. |
| 11 | + |
| 12 | +--- |
| 13 | + |
| 14 | +## Contributor License Agreement |
| 15 | + |
| 16 | +Follow these steps to make a contribution to any of our open source repositories: |
| 17 | + |
| 18 | +1. Ensure that you have completed our CLA Agreement for [individuals](https://www.cloudfoundry.org/wp-content/uploads/2015/07/CFF_Individual_CLA.pdf) or [corporations](https://www.cloudfoundry.org/wp-content/uploads/2015/07/CFF_Corporate_CLA.pdf). |
| 19 | + |
| 20 | +2. Set your name and email (these should match the information on your submitted CLA) |
| 21 | + ``` |
| 22 | + git config --global user.name "Firstname Lastname" |
| 23 | + git config --global user.email "your_email@example.com" |
| 24 | + ``` |
| 25 | + |
| 26 | +3. All contributions must be sent using GitHub pull requests as they create a nice audit trail and structured approach. |
| 27 | + |
| 28 | +The originating github user has to either have a github id on-file with the list of approved users that have signed |
| 29 | +the CLA or they can be a public "member" of a GitHub organization for a group that has signed the corporate CLA. |
| 30 | +This enables the corporations to manage their users themselves instead of having to tell us when someone joins/leaves an organization. By removing a user from an organization's GitHub account, their new contributions are no longer approved because they are no longer covered under a CLA. |
| 31 | + |
| 32 | +If a contribution is deemed to be covered by an existing CLA, then it is analyzed for engineering quality and product |
| 33 | +fit before merging it. |
| 34 | + |
| 35 | +If a contribution is not covered by the CLA, then the automated CLA system notifies the submitter politely that we |
| 36 | +cannot identify their CLA and ask them to sign either an individual or corporate CLA. This happens automatically as a |
| 37 | +comment on pull requests. |
| 38 | + |
| 39 | +When the project receives a new CLA, it is recorded in the project records, the CLA is added to the database for the |
| 40 | +automated system uses, then we manually make the Pull Request as having a CLA on-file. |
| 41 | + |
| 42 | +---- |
| 43 | + |
| 44 | +## Testing |
| 45 | + |
| 46 | +### Prerequisites: |
| 47 | + - [Install Docker](https://docs.docker.com/engine/installation/) |
| 48 | + |
| 49 | +1. To run the unit test suite in a docker image |
| 50 | +```bash |
| 51 | +$ cd bpm-release |
| 52 | +$ ./script/test-with-docker |
| 53 | +``` |
| 54 | + |
| 55 | +2. To run the acceptance tests against docker |
| 56 | +```bash |
| 57 | +$ cd bpm-release |
| 58 | +$ ./scripts/start-docker # this will launch you into the docker shell |
| 59 | +/go# /bpm/scripts/start-test-agent |
| 60 | +/go# ginkgo -r -p -race /bpm/src/bpm-acceptance/ -- --agent-uri="http://127.0.0.1:1337" |
| 61 | +``` |
0 commit comments