Skip to content
This repository has been archived by the owner on Jan 25, 2022. It is now read-only.

Commit

Permalink
Add contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Maria Shaldibina and aram price committed Aug 6, 2013
1 parent 2610ca9 commit 223976f
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,33 @@
# Contributing to Warden

The Cloud Foundry team uses GitHub and accepts contributions via
[pull request](https://help.github.com/articles/using-pull-requests).

## Contributor License Agreement

Follow these steps to make a contribution to any of our open source repositories:

1. Ensure that you have completed our CLA Agreement for
[individuals](http://www.cloudfoundry.org/individualcontribution.pdf) or
[corporations](http://www.cloudfoundry.org/corpcontribution.pdf).

1. Set your name and email (these should match the information on your submitted CLA)

git config --global user.name "Firstname Lastname"
git config --global user.email "your_email@example.com"

## General Workflow

1. Fork the repository
1. Create a feature branch (`git checkout -b better_warden`)
1. Make changes on your branch
1. [Run tests](https://github.com/cloudfoundry/warden#testing)
1. Push to your fork (`git push origin better_warden`) and submit a pull request

We favor pull requests with very small, single commits with a single purpose.

Your pull request is much more likely to be accepted if:

* Your pull request includes tests

* Your pull request is small and focused with a clear message that conveys the intent of your change
4 changes: 4 additions & 0 deletions README.md
Expand Up @@ -45,3 +45,7 @@ The project is licensed under the Apache 2.0 license (see the
[`LICENSE`][license] file).

[license]: /LICENSE

## Contributing

Please read the [contributors' guide](https://github.com/cloudfoundry/warden/blob/master/CONTRIBUTING.md)

0 comments on commit 223976f

Please sign in to comment.