Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Add Contributing guide

  • Loading branch information...
commit 28a1adf8fdce4069b902cb3516a08a02b7361e3a 1 parent c5291e0
Maria Shaldibina and aram price authored
Showing with 37 additions and 0 deletions.
  1. +33 −0 CONTRIBUTING.md
  2. +4 −0 README.md
View
33 CONTRIBUTING.md
@@ -0,0 +1,33 @@
+# Contributing to Health Manager
+
+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_health_manager`)
+1. Make changes on your branch
+1. Run tests `bundle exec rspec`
+1. Push to your fork (`git push origin better_health_manager`) 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
View
4 README.md
@@ -186,3 +186,7 @@ Here are the log levels, with examples of what they're being used for:
* `info` - HM registered a new VCAP component, HM is shutting down
* `debug2` - HM received a heartbeat from a DEA, HM compares an app's desired and known states
* `debug` - HM starts/stops an instance
+
+## Contributing
+
+Please read the [contributors' guide](https://github.com/cloudfoundry/health_manager/blob/master/CONTRIBUTING.md)
Please sign in to comment.
Something went wrong with that request. Please try again.