Skip to content
This repository has been archived by the owner on Sep 6, 2019. It is now read-only.

Commit

Permalink
readme cleanup before opening repo (#35)
Browse files Browse the repository at this point in the history
  • Loading branch information
sebgoa authored and google-prow-robot committed Jul 15, 2018
1 parent c0fcc4a commit 4055320
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 8 deletions.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,33 @@
# Contributing

Welcome, we would love to accept your patches and contributions to this project. There are just a few steps to follow:

## Sign the Contributor License Agreement (CLA).

Before you can contribute, you will need to sign the Contributor License Agreement (CLA).

Contributions to this project must be accompanied by a Contributor License
Agreement. You (or your employer) retain the copyright to your contribution,
this simply gives us permission to use and redistribute your contributions as
part of the project. Head over to [https://cla.developers.google.com/](https://cla.developers.google.com/) to see
your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one
(even if it was for a different project), you probably don't need to do it
again.

## Code of Conduct

Please make sure to read and observe our [Code of Conduct](https://github.com/knative/serving/blob/master/code-of-conduct.md).

## Setting up your development environment

If you haven’t set up your environment, set it up like you would for [Knative Build](https://github.com/knative/build/blob/master/DEVELOPMENT.md).

## Patch submission and review

All submissions, including submissions by project members, require review. We
use GitHub pull requests for this purpose. Consult [GitHub Help] for more
information on using pull requests.

[GitHub Help]: https://help.github.com/articles/about-pull-requests/
21 changes: 13 additions & 8 deletions README.md
@@ -1,10 +1,9 @@
# Knative Build Templates

This repository contains a library of
[`BuildTemplate` resources](https://github.com/knative/build) which
are designed to be reusable by many applications. Each build template
is in a separate directory along with a README.md, so you can choose
which build templates to install on your cluster.
`BuildTemplate` [resources](https://github.com/knative/docs/blob/master/build/build-templates.md) which are designed to be reusable by many applications.

Each build template is in a separate directory along with a README.md and a Kubernetes manifest, so you can choose which build templates to install on your cluster.

## Using Build Templates

Expand Down Expand Up @@ -37,10 +36,10 @@ spec:
url: https://github.com/my-user/my-repo
branch: master
template:
name: buildpack
arguments:
- name: IMAGE
value: us.gcr.io/my-project/my-app
name: buildpack
arguments:
- name: IMAGE
value: us.gcr.io/my-project/my-app
```

Next, create the build you defined:
Expand All @@ -55,3 +54,9 @@ You can check the status of the build using `kubectl`:
```
$ kubectl get build buildpack-build -oyaml
```

## Contributing and Support

If you want to contribute to this repository, please see our [contributing](./CONTRIBUTING.md) guidelines.

If you are looking for support, enter an [issue](https://github.com/knative/build-templates/issues/new) or join our [Slack workspace](https://knative.slack.com/)

0 comments on commit 4055320

Please sign in to comment.